gem-hunter
Language: JavaScript
🖌 docsify cli tool - A magical documentation generator.
🖌 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] [--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:
-lfalsedocsify 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:
--rcfalsedocsify preview release version (rc resource).--theme option:
-tvuevue.--plugins option:
-pfalse<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:
-ofalsefalse. To explicitly set this option to false use --no-open.--port option:
-p30003000.--host option:
-Hlocalhostlocalhost.Docsify's generators.
docsify generate [path] [--sidebar _sidebar.md] [--overwrite]
# docsify g [path] [-s _sidebar.md] [-o]--sidebar option:
-s_sidebar.md_sidebar.md.--overwrite option:
-ofalsePlease see the Contributing Guidelines