Skip to content

Commit 96e285e

Browse files
committed
Update readme
1 parent bb2d711 commit 96e285e

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Use `init` to generate your docs.
5252
```shell
5353
docsify init <path> [--local false] [--theme vue]
5454

55-
# docsify i <path> [--local false] [--theme vue]
55+
# docsify i <path> [-l false] [-t vue]
5656
```
5757

5858
`<path>` defaults to the current directory. Use relative paths like `./docs` (or `docs`).
@@ -75,7 +75,7 @@ Run a server on `localhost` with livereload.
7575
```shell
7676
docsify serve <path> [--open false] [--port 3000]
7777

78-
# docsify s <path> [--open false] [--port 3000]
78+
# docsify s <path> [-o false] [-p 3000]
7979
```
8080

8181
- `--open` option:
@@ -89,6 +89,22 @@ docsify serve <path> [--open false] [--port 3000]
8989
- Default: `3000`
9090
- Description: Choose a listen port, defaults to `3000`.
9191

92+
### `gen` command
93+
94+
Docsify's generators.
95+
96+
```shell
97+
docsify gen <path> [--sidebar _sidebar.md]
98+
99+
# docsify g <path> [-s _sidebar.md]
100+
```
101+
102+
- `--sidebar` option:
103+
- Shorthand: `-s`
104+
- Type: string
105+
- Default: `_sidebar.md`
106+
- Description: Generate sidebar file, defaults to `_sidebar.md`.
107+
92108
## Contributing
93109

94110
Please see the [Contributing Guidelines](./CONTRIBUTING.md)

0 commit comments

Comments
 (0)