Skip to content

Commit a1609d5

Browse files
authored
Add API documentation (typedoc) (#477)
1 parent c7360b1 commit a1609d5

File tree

5 files changed

+437
-0
lines changed

5 files changed

+437
-0
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,6 @@ coverage/*
77

88
nbproject/*
99
dist/
10+
11+
# generated typedocs
12+
docs/api

docs/.vuepress/config.js

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,18 @@ module.exports = {
1818
{base: '/samples', alternative: ['basic']},
1919
],
2020
}],
21+
[
22+
'vuepress-plugin-typedoc',
23+
{
24+
entryPoints: ['../../types/index.d.ts'],
25+
hideInPageTOC: true,
26+
tsconfig: '../../tsconfig.json',
27+
sidebar: {
28+
fullNames: true,
29+
parentCategory: 'API',
30+
},
31+
},
32+
],
2133
],
2234
chainWebpack: (config) => {
2335
config.merge({
@@ -46,6 +58,7 @@ module.exports = {
4658
nav: [
4759
{text: 'Home', link: '/'},
4860
{text: 'Guide', link: '/guide/'},
61+
{text: 'API', link: '/api/'},
4962
{text: 'Samples', link: `/samples/`},
5063
{
5164
text: 'Ecosystem',

0 commit comments

Comments
 (0)