Repository files navigation

🖌 docsify cli - A magical documentation generator.

Gold Sponsor viaOpen Collective

Running a server onlocalhost with live-reload.

Installdocsify-cli vianpm oryarn globally.

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

Useinit 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 (ordocs).

• --local option:
  • Shorthand:-l
  • Type: boolean
  • Default:false
  • Description: Copydocsify files to the docs path, defaults tofalse usingcdn.jsdelivr.net as the content delivery network (CDN). To explicitly set this option tofalse use--no-local.
• --rcMode option:
  • Shorthand:--rc
  • Type: boolean
  • Default:false
  • Description: Trydocsify preview release version (rc resource).
• --theme option:
  • Shorthand:-t
  • Type: string
  • Default:vue
  • Description: Choose a theme, defaults tovue.
• --plugins option:
  • Shorthand:-p
  • Type: boolean
  • Default:false
  • Description: Provide a list of plugins to insert as<script> tags toindex.html.

Run a server onlocalhost 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 tofalse. To explicitly set this option tofalse use--no-open.
• --port option:
  • Shorthand:-p
  • Type: number
  • Default:3000
  • Description: Choose a listen port, defaults to3000.
• --host option:
  • Shorthand:-H
  • Type: string
  • Default:localhost
  • Description: Choose a host to bind to, defaults tolocalhost.

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 theContributing Guidelines

MIT