docsify

🖌 docsify cli - A magical documentation generator.

Backers on Open Collective Sponsors on Open Collective npm Github Actions Status Join Discord community and chat about Docsify license npm-total-download npm-monthly-download

Gold Sponsor via Open Collective

Screencast

Running a server on localhost with live-reload.

Install docsify-cli via npm or yarn globally.

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

Use init to generate your docs.

docsify init [path] [--local false] [--rcMode] [--theme vue] [--plugins]
# docsify i [path] [-l false] [--rc] [-t vue] [-p]

[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.
• --rcMode option:
  • Shorthand: --rc
  • Type: boolean
  • Default: false
  • Description: Try docsify preview release version (rc resource).
• --theme option:
  • Shorthand: -t
  • Type: string
  • Default: vue
  • Description: Choose a theme, defaults to vue.
• --plugins option:
  • Shorthand: -p
  • Type: boolean
  • Default: false
  • Description: Provide a list of plugins to insert as <script> tags to index.html.

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.

Docsify's generators.

docsify generate [path] [--sidebar _sidebar.md] [--overwrite]
# docsify g [path] [-s _sidebar.md] [-o]

• --sidebar option:

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

• --overwrite option:

  • Shorthand: -o
  • Type: boolean
  • Default: false
  • Description: Allow to overwrite generated files.

Please see the Contributing Guidelines

Open in Gitpod

MIT