Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

TsDocs from the SDK #10

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 49 additions & 1 deletion docs/.vuepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,56 @@ import { mdEnhancePlugin } from 'vuepress-plugin-md-enhance';
import { copyCodePlugin } from 'vuepress-plugin-copy-code2';
import { balancerTheme } from '../../theme/';
import { navbar, sidebar } from './configs/index.js';
import { typedocPlugin } from 'vuepress-plugin-typedoc/next';
import fs from 'fs';

const isProd = process.env.NODE_ENV === 'production';

const useTypedoc = fs.existsSync('../balancer-sdk/balancer-js/src/index.ts');

const typedocConfig = typedocPlugin({
// TypeDoc options
entryPoints: ['../balancer-sdk/balancer-js/src/index.ts'],
tsconfig: '../balancer-sdk/balancer-js/tsconfig.json',
compilerOptions: {
strictPropertyInitialization: false
},
cleanOutputDir: true,
excludeNotDocumented: true,
excludeNotDocumentedKinds: [
"Module",
"Namespace",
// "Enum",
// "EnumMember", // Not enabled by default
"Variable",
"Function",
"Class",
"Interface",
// "Constructor",
// "Property",
// "Method",
// "CallSignature",
// "IndexSignature",
// "ConstructorSignature",
"Accessor",
// "GetSignature",
// "SetSignature",
// "TypeAlias",
"Reference",
],
excludeInternal: true,
excludePrivate: true,
gitRevision: "master",
// Plugin options
out: "sdk/reference",
hideInPageTOC: true,
sidebar: {
autoConfiguration: false,
// fullNames: true,
parentCategory: "Reference"
}
});

export default defineUserConfig({
// set site base to default value
base: '/',
Expand Down Expand Up @@ -67,6 +114,7 @@ export default defineUserConfig({
// use plugins
plugins: [
copyCodePlugin({}),
useTypedoc ? typedocConfig : null,
mdEnhancePlugin({
mathjax: true,
container: true,
Expand All @@ -76,5 +124,5 @@ export default defineUserConfig({
chart: true,
mermaid: true,
}),
],
].filter((p) => p !== null),
});
2 changes: 1 addition & 1 deletion docs/.vuepress/configs/navbar/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ export const navbar: NavbarConfig = [
},
{
text: 'SDK',
link: '/sdk/overview',
link: '/sdk/reference',
},
{
text: 'Developer Guides',
Expand Down
Binary file added docs/.vuepress/public/images/IL-class.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.vuepress/public/images/img.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 0 additions & 1 deletion docs/sdk/overview/.order

This file was deleted.

49 changes: 0 additions & 49 deletions docs/sdk/overview/README.md

This file was deleted.

Loading