Skip to content

Commit c7435ea

Browse files
authored
Add API docs (#771)
1 parent bbc6b13 commit c7435ea

File tree

6 files changed

+299
-0
lines changed

6 files changed

+299
-0
lines changed

.github/release-drafter.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ template: |
4444
* [npm](https://www.npmjs.com/package/chartjs-plugin-annotation)
4545
* [Migration guide](https://www.chartjs.org/chartjs-plugin-annotation/latest/guide/migrationV2.html)
4646
* [Docs](https://www.chartjs.org/chartjs-plugin-annotation/)
47+
* [API](https://www.chartjs.org/chartjs-plugin-annotation/latest/api/)
4748
* [Samples](https://www.chartjs.org/chartjs-plugin-annotation/latest/samples/intro.html)
4849
4950
$CHANGES

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
/dist
66
/gh-pages
77
/docs/.docusaurus
8+
# generated typedocs
9+
docs/api
810

911
# Node.js
1012
node_modules/

docs/.vuepress/config.js

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,18 @@ module.exports = {
1919
{base: '/samples', alternative: ['intro']},
2020
],
2121
}],
22+
[
23+
'vuepress-plugin-typedoc',
24+
{
25+
entryPoints: ['../../types/index.d.ts'],
26+
hideInPageTOC: true,
27+
tsconfig: 'tsconfig.json',
28+
sidebar: {
29+
fullNames: true,
30+
parentCategory: 'API',
31+
},
32+
},
33+
],
2234
['@simonbrunel/vuepress-plugin-versions', {
2335
filters: {
2436
suffix: (tag) => tag ? ` (${tag})` : '',
@@ -82,10 +94,14 @@ module.exports = {
8294
},
8395
nav: [
8496
{text: 'Home', link: '/'},
97+
{text: 'API', link: '/api/'},
8598
{text: 'Guide', link: '/guide/'},
8699
{text: 'Samples', link: '/samples/'},
87100
],
88101
sidebar: {
102+
'/api/': {
103+
title: 'API'
104+
},
89105
'/guide/': [
90106
'',
91107
'integration',

0 commit comments

Comments
 (0)