Skip to content

Commit

Permalink
docs: update readme and index.html
Browse files Browse the repository at this point in the history
  • Loading branch information
sy-records committed Jan 27, 2022
1 parent 519c26f commit b7e26bd
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 28 deletions.
70 changes: 43 additions & 27 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,26 +37,26 @@ Use `init` to generate your docs.
```shell
docsify init <path> [--local false] [--theme vue] [--plugins false]

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

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

* `--local` option:
* Shorthand: `-l`
* Type: boolean
* Default: `false`
* 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`.
* `--theme` option:
* Shorthand: `-t`
* Type: string
* Default: `vue`
* Description: Choose a theme, defaults to `vue`, other choices are `buble`, `dark` and `pure`.
* `--plugins` option:
* Shorthand: `-p`
* Type: array
* Default: `[]`
* Description: Provide a list of plugins to insert as `<script>` tags to `index.html`.
- `--local` option:
- Shorthand: `-l`
- Type: boolean
- Default: `false`
- 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`.
- `--theme` option:
- Shorthand: `-t`
- Type: string
- Default: `vue`
- Description: Choose a theme, defaults to `vue`, other choices are `buble`, `dark` and `pure`.
- `--plugins` option:
- Shorthand: `-p`
- Type: boolean
- Default: `false`
- Description: Provide a list of plugins to insert as `<script>` tags to `index.html`.

### `serve` command

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

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

* `--open` option:
* Shorthand: `-o`
* Type: boolean
* Default: `false`
* Description: Open the docs in the default browser, defaults to `false`. To explicitly set this option to `false` use `--no-open`.
* `--port` option:
* Shorthand: `-p`
* Type: number
* Default: `3000`
* Description: Choose a listen port, defaults to `3000`.
- `--open` option:
- Shorthand: `-o`
- Type: boolean
- Default: `false`
- Description: Open the docs in the default browser, defaults to `false`. To explicitly set this option to `false` use `--no-open`.
- `--port` option:
- Shorthand: `-p`
- Type: number
- Default: `3000`
- Description: Choose a listen port, defaults to `3000`.

### `generate` command

Docsify's generators.

```shell
docsify generate <path> [--sidebar _sidebar.md]

# docsify g <path> [-s _sidebar.md]
```

- `--sidebar` option:
- Shorthand: `-s`
- Type: string
- Default: `_sidebar.md`
- Description: Generate sidebar file, defaults to `_sidebar.md`.

## License

Expand Down
1 change: 0 additions & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@
<script>
window.$docsify = {
name: 'docsify-cli',
basePath: '/docsify-cli/',
repo: 'docsifyjs/docsify-cli'
}
</script>
Expand Down

0 comments on commit b7e26bd

Please sign in to comment.