🖌 docsify cli - A magical documentation generator.
Gold Sponsor via Open Collective
Running a server on
localhostwith live-reload.
Install docsify-cli via npm or yarn globally.
npm i docsify-cli -g
# yarn global add docsify-cliUse 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).
--localoption:- Shorthand:
-l - Type: boolean
- Default:
false - Description: Copy
docsifyfiles to the docs path, defaults tofalseusingcdn.jsdelivr.netas the content delivery network (CDN). To explicitly set this option tofalseuse--no-local.
- Shorthand:
--themeoption:- Shorthand:
-t - Type: string
- Default:
vue - Description: Choose a theme, defaults to
vue, other choices arebuble,darkandpure.
- Shorthand:
--pluginsoption:- Shorthand:
-p - Type: boolean
- Default:
false - Description: Provide a list of plugins to insert as
<script>tags toindex.html.
- Shorthand:
Run a server on localhost with livereload.
docsify serve [path] [--open false] [--port 3000]
# docsify s [path] [-o false] [-p 3000]--openoption:- Shorthand:
-o - Type: boolean
- Default:
false - Description: Open the docs in the default browser, defaults to
false. To explicitly set this option tofalseuse--no-open.
- Shorthand:
--portoption:- Shorthand:
-p - Type: number
- Default:
3000 - Description: Choose a listen port, defaults to
3000.
- Shorthand:
Docsify's generators.
docsify generate [path] [--sidebar _sidebar.md] [--overwrite]
# docsify g [path] [-s _sidebar.md] [-o]-
--sidebaroption:- Shorthand:
-s - Type: string
- Default:
_sidebar.md - Description: Generate sidebar file, defaults to
_sidebar.md.
- Shorthand:
-
--overwriteoption:- Shorthand:
-o - Type: boolean
- Default:
false - Description: Allow overwrite generated files.
- Shorthand:
Please see the Contributing Guidelines
