Skip to content

Commit

Permalink
sdk ts docs
Browse files Browse the repository at this point in the history
  • Loading branch information
gmbronco committed Mar 1, 2023
1 parent af8a59d commit a7dff02
Show file tree
Hide file tree
Showing 41 changed files with 10,885 additions and 2,658 deletions.
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),
});
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.
Loading

0 comments on commit a7dff02

Please sign in to comment.