Skip to content

Commit 0ef1050

Browse files
SombreroElGringoHyunje Jun
authored andcommitted
Replace documentation engine (#85)
* Replace documentation engine • Replace the docs by VuePress * Set the base URL • The base URL the site will be deployed at
1 parent 7a14b33 commit 0ef1050

20 files changed

+92
-25
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,7 @@ Here are each top-level directory explained:
1818
* `lib`: TypeScript source code. You may modify files under this directory.
1919
* `test`: Mocha test suites. Please add tests for modification if possible.
2020
* `examples`: Example projects using this SDK
21-
* `docs`: [GitBook](https://www.gitbook.com/) markdowns for project documentation
22-
+ Please install GitBook first to modify/build documentation: `npm i -g gitbook-cli`
21+
* `docs`: [VuePress](https://vuepress.vuejs.org) markdowns for project documentation
2322
* `tools`: Useful tools
2423

2524
Also, you may use the following npm scripts for development:

docs/.vuepress/config.js

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

docs/.vuepress/public/favicon.ico

51.9 KB
Binary file not shown.
File renamed without changes.
File renamed without changes.

docs/book.json

Lines changed: 0 additions & 4 deletions
This file was deleted.

0 commit comments

Comments
 (0)