Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
docsify-cli
Advanced tools
Changelog
4.4.4 (2022-03-12)
Readme
🖌 docsify cli - A magical documentation generator.
Gold Sponsor via Open Collective
Running a server on
localhost
with live-reload.
Install docsify-cli
via npm
or yarn
globally.
npm i docsify-cli -g
# yarn global add docsify-cli
init
commandUse 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:
-l
false
docsify
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
.--theme
option:
-t
vue
vue
, other choices are buble
, dark
and pure
.--plugins
option:
-p
false
<script>
tags to index.html
.serve
commandRun a server on localhost
with livereload.
docsify serve <path> [--open false] [--port 3000]
# docsify s <path> [-o false] [-p 3000]
--open
option:
-o
false
false
. To explicitly set this option to false
use --no-open
.--port
option:
-p
3000
3000
.generate
commandDocsify's generators.
docsify generate <path> [--sidebar _sidebar.md]
# docsify g <path> [-s _sidebar.md]
--sidebar
option:
-s
_sidebar.md
_sidebar.md
.Please see the Contributing Guidelines
FAQs
A magical documentation generator.
The npm package docsify-cli receives a total of 21,273 weekly downloads. As such, docsify-cli popularity was classified as popular.
We found that docsify-cli demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 7 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.