docsify-cli
A magical documentation generator.
Last updated a month ago by anixsaha .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install docsify-cli 
SYNC missed versions from official npm registry.

docsify

???? docsify cli - A magical documentation generator.

Backers on Open Collective Sponsors on Open Collective Travis Status npm gitter license npm-total-download npm-monthly-download

Gold Sponsor via Open Collective

Screencast

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]

# docsify i <path> [--local false] [--theme vue]

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

serve command

Run a server on localhost with livereload.

docsify serve <path> [--open false] [--port 3000]

# docsify s <path> [--open false] [--port 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.

Contributing

Please see the Contributing Guidelines

Contribution

Open in Gitpod

License

MIT

Current Tags

  • 4.4.1                                ...           latest (a month ago)
  • 4.0.2                                ...           next (3 years ago)

49 Versions

  • 4.4.1                                ...           a month ago
  • 4.4.0                                ...           8 months ago
  • 4.3.0                                ...           2 years ago
  • 4.2.1                                ...           2 years ago
  • 4.2.0                                ...           3 years ago
  • 4.1.12                                ...           3 years ago
  • 4.1.11                                ...           3 years ago
  • 4.1.10                                ...           3 years ago
  • 4.1.9                                ...           3 years ago
  • 4.1.8                                ...           3 years ago
  • 4.1.7                                ...           3 years ago
  • 4.1.6                                ...           3 years ago
  • 4.1.5                                ...           3 years ago
  • 4.1.4                                ...           3 years ago
  • 4.1.3                                ...           3 years ago
  • 4.1.2                                ...           3 years ago
  • 4.1.1                                ...           3 years ago
  • 4.1.0                                ...           3 years ago
  • 4.0.2                                ...           3 years ago
  • 4.0.1                                ...           3 years ago
  • 4.0.0                                ...           3 years ago
  • 3.3.2                                ...           3 years ago
  • 3.3.1                                ...           3 years ago
  • 3.3.0                                ...           3 years ago
  • 3.2.5                                ...           3 years ago
  • 3.2.4                                ...           3 years ago
  • 3.2.3                                ...           3 years ago
  • 3.2.2                                ...           3 years ago
  • 3.2.1                                ...           3 years ago
  • 3.2.0                                ...           3 years ago
  • 3.1.1                                ...           3 years ago
  • 3.1.0                                ...           3 years ago
  • 3.0.2                                ...           3 years ago
  • 3.0.1                                ...           3 years ago
  • 3.0.0                                ...           3 years ago
  • 2.1.0                                ...           3 years ago
  • 2.0.0                                ...           3 years ago
  • 1.5.1                                ...           3 years ago
  • 1.5.0                                ...           3 years ago
  • 1.4.0                                ...           3 years ago
  • 1.3.0                                ...           3 years ago
  • 1.2.1                                ...           4 years ago
  • 1.2.0                                ...           4 years ago
  • 1.1.1                                ...           4 years ago
  • 1.1.0                                ...           4 years ago
  • 1.0.0                                ...           4 years ago
  • 0.2.2                                ...           4 years ago
  • 0.2.1                                ...           4 years ago
  • 0.1.0                                ...           4 years ago

Copyright 2014 - 2016 © taobao.org |