🖌 docsify cli - A magical documentation generator.

Gold Sponsor via Open Collective

Screencast

Running a server on localhost with live-reload.

Installation

Install docsify-cli via npm or yarn globally.

npm i docsify-cli -g
# yarn global add docsify-cli

Usage

init command

Use init to generate your docs.

docsify init <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 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

Run a server on localhost with livereload.

docsify serve <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.

generate command

Docsify's generators.

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.

Contributing

Please see the Contributing Guidelines

Contribution

License

MIT

Changelog

All notable changes to this project will be documented in this file. See standard-version for commit guidelines.

4.4.4 (2022-03-12)

Features

• support docsify init --plugins (#99) (8bb295c), closes /github.com/docsifyjs/docsify-cli/pull/99#discussion_r621952975

Bug Fixes

• package.json & package-lock.json to reduce vulnerabilities (#161) (e9ea2c1)
• Repeat generation and hump naming (#164) (238326e)
• Support refresh and livereload in serve when using routerMode history (#166) (625c9f2)

4.4.3 (2021-03-09)

Features

• auto generate sidebar (#130) (e83bfcb)

4.4.2 (2020-11-17)

Features

• Added asking whether to rewrite files (#117) (f811906)
• Included docsify version in url for the template (#107) (d92d030)

Bug Fixes

• alias not working (#125) (f3af553)

4.4.1 (2020-06-05)

Bug Fixes

• Allow config flag to take a parameter (9b35260)
• generate snapshot for default behavior (3ebfd82)
• lint (10c29c9)
• lint codebase (518b3ef)
• lint-staged config (fa1c125)
• remove redundant snapshot files (4f69e30)
• tweak (959741d)
• tweak (463f642)
• typo (94c60be)

4.4.0 (2019-11-20)

Features

• chore: show up help if no args were passed (#72) (2226057), closes #71
• serve: add --index-name to rewrite default index name (#48) (dc8e993)

Bug Fixes

• chore: warn on unknown commands and command recommendation (#74) (b46a707)
• npm audit issues (ac1bcc3)
• remove gulp-connect (032817b)

4.1.9 (2017-07-12)

Performance Improvements

• serve: exclude node_modules from livereload (#17) (3f488d0)

4.1.8 (2017-05-31)

4.1.7 (2017-05-30)

Bug Fixes

• ssr: clean files (8e81b1a)

4.1.6 (2017-05-30)

Bug Fixes

• ssr: add debug (653f24f)

4.1.5 (2017-05-30)

Bug Fixes

• ssr: missing package (86e6511)

4.1.4 (2017-05-30)

Bug Fixes

• ssr: file path (924a6cf)

4.1.3 (2017-05-30)

Bug Fixes

• update babel config (49dbfe6)

4.1.2 (2017-05-30)

Bug Fixes

• update babel config (7095a0a)

4.1.1 (2017-05-30)

Bug Fixes

• update docsify-server-renderer (ce7833e)

4.1.0 (2017-05-30)

Bug Fixes

• update docsify-server-renderer (7f56467)

Features

• test history mode (f898a01)

4.0.2 (2017-05-29)

Bug Fixes

• remove context (8b3679f)

4.0.1 (2017-05-29)

Bug Fixes

• path => context (d83fa69)

4.0.0 (2017-05-29)

Features

• add start command (#14) (feefcce)

3.3.2 (2017-04-28)

3.3.1 (2017-03-26)

3.3.0 (2017-03-24)

Bug Fixes

• pkg.engines (3e50f07)
• template: update template (da67d07)

Features

• dev: add gulp tasks (76f0193)

3.2.5 (2017-03-23)

3.2.4 (2017-03-19)

Bug Fixes

• grammar: isOpen --> openInBrowser (d823a07)
• travis-ci (a313412)

Features

• cli: print shell completion script (804639e)
• cli: support completion rules (fb31bd5)

3.2.3 (2017-03-17)

3.2.2 (2017-03-17)

3.2.1 (2017-03-15)

3.2.0 (2017-03-15)

3.1.1 (2017-03-14)

Bug Fixes

• default print help info (54567bc)

3.1.0 (2017-03-14)

Features

• locale: add zh-cn (2c5e19f)

3.0.2 (2017-03-10)

3.0.1 (2017-02-19)

3.0.0 (2017-02-19)

2.1.0 (2017-02-09)

Features

• add livereload (661cbe2)

2.0.0 (2017-02-05)

1.5.1 (2017-01-24)

1.5.0 (2017-01-24)

1.4.0 (2017-01-14)

1.3.0 (2017-01-13)

1.2.1 (2016-12-24)

1.2.0 (2016-12-24)

1.1.1 (2016-12-19)

1.1.0 (2016-12-18)

1.0.0 (2016-12-08)

0.2.2 (2016-11-28)

0.2.1 (2016-11-27)

0.1.0 (2016-11-24)