@webappsconception/docsify-cli
v5.0.4
Published
A magical documentation generator, upgraded by Rudy.
Downloads
9
Maintainers
Readme
💡 Note Rudy : This project uses version 4.4.4 of the official repository docsifyjs/docsify-cli in order to meet a security need at the network interface level of listening, and traceability of connections.
Screencast
Running a server on
localhost
with live-reload.
Installation
Install docsify-cli
via npm
or yarn
globally.
npm i @webappsconception/docsify-cli -g
# yarn global add @webappsconception/docsify-cli
Usage
init
command
Use 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
).
--local
option:- Shorthand:
-l
- Type: boolean
- Default:
false
- Description: Copy
docsify
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
.
- Shorthand:
--theme
option:- Shorthand:
-t
- Type: string
- Default:
vue
- Description: Choose a theme, defaults to
vue
, other choices arebuble
,dark
andpure
.
- Shorthand:
--plugins
option:- Shorthand:
-p
- Type: boolean
- Default:
false
- Description: Provide a list of plugins to insert as
<script>
tags toindex.html
.
- Shorthand:
serve
command
Run a server on localhost
with livereload.
docsify serve [path] [--open false] [--ip 127.0.0.1] [--port 3000] [--log logfile]
# docsify s [path] [-o false] [-I 127.0.0.1] [-p 3000] [-l logfile]
--open
option:- Shorthand:
-o
- Type: boolean
- Default:
false
- Description: Open the docs in the default browser, defaults to
false
. To explicitly set this option tofalse
use--no-open
.
- Shorthand:
--port
option:- Shorthand:
-p
- Type: number
- Default:
3000
- Description: Choose a listen port, defaults to
3000
.
- Shorthand:
--ip
option:- Shorthand:
-I
- Type: number
- Default:
127.0.0.1
- Description: Choose a adresse ip of the listening interface, defaults to
127.0.0.1
.
- Shorthand:
--log
option:- Shorthand:
-l
- Type: number
- Description: Log file.
- Shorthand:
generate
command
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
.
- Shorthand:
--overwrite
option:- Shorthand:
-o
- Type: boolean
- Default:
false
- Description: Allow overwrite generated files.
- Shorthand:
Contributing
Please see the Contributing Guidelines