Skip to content

Commit b7e26bd

Browse files
committed
docs: update readme and index.html
1 parent 519c26f commit b7e26bd

File tree

2 files changed

+43
-28
lines changed

2 files changed

+43
-28
lines changed

docs/README.md

+43-27
Original file line numberDiff line numberDiff line change
@@ -37,26 +37,26 @@ Use `init` to generate your docs.
3737
```shell
3838
docsify init <path> [--local false] [--theme vue] [--plugins false]
3939

40-
# docsify i <path> [--local false] [--theme vue] [--plugins false]
40+
# docsify i <path> [-l false] [-t vue] [--plugins false]
4141
```
4242

4343
`<path>` defaults to the current directory. Use relative paths like `./docs` (or `docs`).
4444

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`.
6060

6161
### `serve` command
6262

@@ -65,19 +65,35 @@ Run a server on `localhost` with livereload.
6565
```shell
6666
docsify serve <path> [--open false] [--port 3000]
6767

68-
# docsify s <path> [--open false] [--port 3000]
68+
# docsify s <path> [-o false] [-p 3000]
6969
```
7070

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`.
8197

8298
## License
8399

docs/index.html

-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@
1313
<script>
1414
window.$docsify = {
1515
name: 'docsify-cli',
16-
basePath: '/docsify-cli/',
1716
repo: 'docsifyjs/docsify-cli'
1817
}
1918
</script>

0 commit comments

Comments
 (0)