Skip to content

Commit 63ebbcf

Browse files
committed
generate apidocs from code!
1 parent 5cad86e commit 63ebbcf

File tree

10 files changed

+255
-1219
lines changed

10 files changed

+255
-1219
lines changed

docs/.vuepress/config.js

Lines changed: 79 additions & 84 deletions
Original file line numberDiff line numberDiff line change
@@ -1,89 +1,84 @@
1-
import { defaultTheme } from 'vuepress'
1+
import {defaultTheme} from 'vuepress'
22

33
export default {
4-
base: "/line-bot-sdk-nodejs/",
5-
head: [
6-
["link", { rel: "icon", href: "/favicon.ico" }]
7-
],
8-
title: "line-bot-sdk-nodejs",
9-
description: "Node.js SDK for LINE Messaging API",
10-
theme: defaultTheme({
11-
// default theme config
12-
navbar: [
13-
{
14-
text: "Introduction",
15-
link: "/"
16-
},
17-
{
18-
text: "Getting Started",
19-
link: "/getting-started"
20-
},
21-
{
22-
text: "Guide",
23-
link: "/guide"
24-
},
25-
{
26-
text: "API Reference",
27-
link: "/api-reference"
28-
29-
},
30-
{
31-
text: "Contributing",
32-
link: "/CONTRIBUTING"
33-
},
34-
{
35-
text: "LINE Developers",
36-
link: "https://developers.line.biz/en/"
37-
},
38-
{
39-
text: "GitHub",
40-
link: "https://github.com/line/line-bot-sdk-nodejs/"
41-
},
4+
base: "/line-bot-sdk-nodejs/",
5+
head: [
6+
["link", {rel: "icon", href: "/favicon.ico"}]
427
],
43-
sidebar: [
44-
{
45-
title: "Introduction",
46-
collapsable: false,
47-
children: [
48-
"",
49-
]
50-
},
51-
{
52-
title: "Getting Started",
53-
collapsable: false,
54-
children: [
55-
"/getting-started/requirements",
56-
"/getting-started/install",
57-
"/getting-started/basic-usage",
58-
]
59-
},
60-
{
61-
title: "Guide",
62-
collapsable: false,
63-
children: [
64-
"/guide/webhook",
65-
"/guide/client",
66-
"/guide/typescript",
67-
]
68-
},
69-
{
70-
title: "API Reference",
71-
collapsable: false,
72-
children: [
73-
"/api-reference/client",
74-
"/api-reference/validate-signature",
75-
"/api-reference/middleware",
76-
"/api-reference/exceptions",
77-
"/api-reference/message-and-event-objects",
78-
]
79-
},
80-
{
81-
title: "Contributing",
82-
collapsable: false,
83-
children: [
84-
"/CONTRIBUTING",
8+
title: "line-bot-sdk-nodejs",
9+
description: "Node.js SDK for LINE Messaging API",
10+
theme: defaultTheme({
11+
// default theme config
12+
navbar: [
13+
{
14+
text: "Introduction",
15+
link: "/"
16+
},
17+
{
18+
text: "Getting Started",
19+
link: "/getting-started"
20+
},
21+
{
22+
text: "Guide",
23+
link: "/guide"
24+
},
25+
{
26+
text: "API Reference",
27+
link: "/apidocs/modules.html"
28+
},
29+
{
30+
text: "Contributing",
31+
link: "/CONTRIBUTING"
32+
},
33+
{
34+
text: "LINE Developers",
35+
link: "https://developers.line.biz/en/"
36+
},
37+
{
38+
text: "GitHub",
39+
link: "https://github.com/line/line-bot-sdk-nodejs/"
40+
},
41+
],
42+
sidebar: [
43+
{
44+
title: "Introduction",
45+
collapsable: false,
46+
children: [
47+
"",
48+
]
49+
},
50+
{
51+
title: "Getting Started",
52+
collapsable: false,
53+
children: [
54+
"/getting-started/requirements",
55+
"/getting-started/install",
56+
"/getting-started/basic-usage",
57+
]
58+
},
59+
{
60+
title: "Guide",
61+
collapsable: false,
62+
children: [
63+
"/guide/webhook",
64+
"/guide/client",
65+
"/guide/typescript",
66+
]
67+
},
68+
{
69+
title: "API Reference",
70+
collapsable: false,
71+
children: [
72+
"/apidocs/modules.html"
73+
]
74+
},
75+
{
76+
title: "Contributing",
77+
collapsable: false,
78+
children: [
79+
"/CONTRIBUTING",
80+
]
81+
},
8582
]
86-
},
87-
]
88-
}),
83+
}),
8984
}

docs/api-reference.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,5 @@ For the detailed API reference of each, please refer to their own pages.
1818
- [middleware](api-reference/middleware.md)
1919
- [Exceptions](api-reference/exceptions.md)
2020
- [Message and event objects](api-reference/message-and-event-objects.md)
21+
- [Reference document](apidoc/README.md)
22+
- [Reference document](apidoc/modules.md)

0 commit comments

Comments
 (0)