You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# docsify i <path> [--local false] [--theme vue] [--plugins false]
40
+
# docsify i <path> [-l false] [-t vue] [--plugins false]
41
41
```
42
42
43
43
`<path>` defaults to the current directory. Use relative paths like `./docs` (or `docs`).
44
44
45
-
*`--local` option:
46
-
* Shorthand: `-l`
47
-
* Type: boolean
48
-
* Default: `false`
49
-
* Description: Copy `docsify` files to the docs path, defaults to `false` using `unpkg.com` as the content delivery network (CDN). To explicitly set this option to `false` use `--no-local`.
50
-
*`--theme` option:
51
-
* Shorthand: `-t`
52
-
* Type: string
53
-
* Default: `vue`
54
-
* Description: Choose a theme, defaults to `vue`, other choices are `buble`, `dark` and `pure`.
55
-
*`--plugins` option:
56
-
* Shorthand: `-p`
57
-
* Type: array
58
-
* Default: `[]`
59
-
* Description: Provide a list of plugins to insert as `<script>` tags to `index.html`.
45
+
-`--local` option:
46
+
- Shorthand: `-l`
47
+
- Type: boolean
48
+
- Default: `false`
49
+
- Description: Copy `docsify` files to the docs path, defaults to `false` using `cdn.jsdelivr.net` as the content delivery network (CDN). To explicitly set this option to `false` use `--no-local`.
50
+
-`--theme` option:
51
+
- Shorthand: `-t`
52
+
- Type: string
53
+
- Default: `vue`
54
+
- Description: Choose a theme, defaults to `vue`, other choices are `buble`, `dark` and `pure`.
55
+
-`--plugins` option:
56
+
- Shorthand: `-p`
57
+
- Type: boolean
58
+
- Default: `false`
59
+
- Description: Provide a list of plugins to insert as `<script>` tags to `index.html`.
60
60
61
61
### `serve` command
62
62
@@ -65,19 +65,35 @@ Run a server on `localhost` with livereload.
65
65
```shell
66
66
docsify serve <path> [--open false] [--port 3000]
67
67
68
-
# docsify s <path> [--open false] [--port 3000]
68
+
# docsify s <path> [-o false] [-p 3000]
69
69
```
70
70
71
-
*`--open` option:
72
-
* Shorthand: `-o`
73
-
* Type: boolean
74
-
* Default: `false`
75
-
* Description: Open the docs in the default browser, defaults to `false`. To explicitly set this option to `false` use `--no-open`.
76
-
*`--port` option:
77
-
* Shorthand: `-p`
78
-
* Type: number
79
-
* Default: `3000`
80
-
* Description: Choose a listen port, defaults to `3000`.
71
+
-`--open` option:
72
+
- Shorthand: `-o`
73
+
- Type: boolean
74
+
- Default: `false`
75
+
- Description: Open the docs in the default browser, defaults to `false`. To explicitly set this option to `false` use `--no-open`.
76
+
-`--port` option:
77
+
- Shorthand: `-p`
78
+
- Type: number
79
+
- Default: `3000`
80
+
- Description: Choose a listen port, defaults to `3000`.
81
+
82
+
### `generate` command
83
+
84
+
Docsify's generators.
85
+
86
+
```shell
87
+
docsify generate <path> [--sidebar _sidebar.md]
88
+
89
+
# docsify g <path> [-s _sidebar.md]
90
+
```
91
+
92
+
-`--sidebar` option:
93
+
- Shorthand: `-s`
94
+
- Type: string
95
+
- Default: `_sidebar.md`
96
+
- Description: Generate sidebar file, defaults to `_sidebar.md`.
0 commit comments