Skip to content

Commit ef4fdee

Browse files
sy-recordssy-records
committed
docs: update README
1 parent d7b7e22 commit ef4fdee

File tree

2 files changed

+17
-7
lines changed

2 files changed

+17
-7
lines changed

‎README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,9 @@ npm i docsify-cli -g
5050
Use `init` to generate your docs.
5151

5252
```shell
53-
docsify init [path] [--local false] [--theme vue] [--plugins false]
53+
docsify init [path] [--local false] [--rcMode] [--theme vue] [--plugins]
5454

55-
# docsify i [path] [-l false] [-t vue] [--plugins false]
55+
# docsify i [path] [-l false] [--rc] [-t vue] [-p]
5656
```
5757

5858
`[path]` defaults to the current directory. Use relative paths like `./docs` (or `docs`).
@@ -67,6 +67,11 @@ docsify init [path] [--local false] [--theme vue] [--plugins false]
6767
- Type: boolean
6868
- Default: `false`
6969
- Description: Try `docsify` preview release version (`rc` resource).
70+
- `--theme` option:
71+
- Shorthand: `-t`
72+
- Type: string
73+
- Default: `vue`
74+
- Description: Choose a theme, defaults to `vue`.
7075
- `--plugins` option:
7176
- Shorthand: `-p`
7277
- Type: boolean
@@ -114,7 +119,7 @@ docsify generate [path] [--sidebar _sidebar.md] [--overwrite]
114119
- Shorthand: `-o`
115120
- Type: boolean
116121
- Default: `false`
117-
- Description: Allow overwrite generated files.
122+
- Description: Allow to overwrite generated files.
118123

119124
## Contributing
120125
Please see the [Contributing Guidelines](./CONTRIBUTING.md)

‎docs/README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,9 @@ npm i docsify-cli -g
3535
Use `init` to generate your docs.
3636

3737
```shell
38-
docsify init [path] [--local false] [--theme vue] [--plugins false]
38+
docsify init [path] [--local false] [--rcMode] [--theme vue] [--plugins]
3939

40-
# docsify i [path] [-l false] [-t vue] [--plugins false]
40+
# docsify i [path] [-l false] [--rc] [-t vue] [-p]
4141
```
4242

4343
`[path]` defaults to the current directory. Use relative paths like `./docs` (or `docs`).
@@ -47,11 +47,16 @@ docsify init [path] [--local false] [--theme vue] [--plugins false]
4747
- Type: boolean
4848
- Default: `false`
4949
- 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+
- `--rcMode` option:
51+
- Shorthand: `--rc`
52+
- Type: boolean
53+
- Default: `false`
54+
- Description: Try `docsify` preview release version (`rc` resource).
5055
- `--theme` option:
5156
- Shorthand: `-t`
5257
- Type: string
5358
- Default: `vue`
54-
- Description: Choose a theme, defaults to `vue`, other choices are `buble`, `dark` and `pure`.
59+
- Description: Choose a theme, defaults to `vue`.
5560
- `--plugins` option:
5661
- Shorthand: `-p`
5762
- Type: boolean
@@ -99,7 +104,7 @@ docsify generate [path] [--sidebar _sidebar.md] [--overwrite]
99104
- Shorthand: `-o`
100105
- Type: boolean
101106
- Default: `false`
102-
- Description: Allow overwrite generated files.
107+
- Description: Allow to overwrite generated files.
103108

104109
## License
105110

0 commit comments

Comments
 (0)