Gathering detailed insights and metrics for docsify-cli
Gathering detailed insights and metrics for docsify-cli
Installations
npm install docsify-cliDeveloper Guide
BETA
Typescript
No
Module System
CommonJS
Min. Node Version
>= 10
Node Version
14.17.6
NPM Version
6.14.15
Score
76.9
Supply Chain
94
Quality
79
Maintenance
50
Vulnerability
98.9
License
Releases
3
Languages
2
JavaScript
HTML
JavaScript (94.57%)
HTML (5.43%)
Developer
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
MIT License
742 Stars
284 Commits
159 Forks
20 Watchers
6 Branches
31 Contributors
Updated on Jul 08, 2025
Maintainers
7
Package Meta Information
Latest Version
4.4.4
Package Id
docsify-cli@4.4.4
Unpacked Size
42.59 kB
Size
11.91 kB
File Count
21
NPM Version
6.14.15
Node Version
14.17.6
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
17
🖌 docsify cli - A magical documentation generator.
Gold Sponsor via Open Collective
Screencast
Running a server on
localhostwith live-reload.
Installation
Install docsify-cli via npm or yarn globally.
1npm i docsify-cli -g 2# yarn global add docsify-cli
Usage
init command
Use init to generate your docs.
1docsify init <path> [--local false] [--theme vue] [--plugins false] 2 3# 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:
serve command
Run a server on localhost with livereload.
1docsify serve <path> [--open false] [--port 3000] 2 3# 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:
generate command
Docsify's generators.
1docsify generate <path> [--sidebar _sidebar.md] 2 3# docsify g <path> [-s _sidebar.md]
--sidebaroption:- Shorthand:
-s - Type: string
- Default:
_sidebar.md - Description: Generate sidebar file, defaults to
_sidebar.md.
- Shorthand:
Contributing
Please see the Contributing Guidelines
Contribution
License
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
security policy file detected
Details
- Info: security policy file detected: github.com/docsifyjs/.github/SECURITY.md:1
- Info: Found linked content: github.com/docsifyjs/.github/SECURITY.md:1
- Info: Found disclosure, vulnerability, and/or timelines in security policy: github.com/docsifyjs/.github/SECURITY.md:1
- Info: Found text in security policy: github.com/docsifyjs/.github/SECURITY.md:1
Reason
Found 8/14 approved changesets -- score normalized to 5
Reason
dependency not pinned by hash detected -- score normalized to 3
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docsify-cli.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/docsifyjs/docsify-cli/docsify-cli.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docsify-cli.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/docsifyjs/docsify-cli/docsify-cli.yml/master?enable=pin
- Info: 0 out of 2 GitHub-owned GitHubAction dependencies pinned
- Info: 1 out of 1 npmCommand dependencies pinned
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/docsify-cli.yml:1
- Info: no jobLevel write permissions found
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 27 are checked with a SAST tool
Reason
14 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8
- Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
- Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
- Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97
- Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
- Warn: Project is vulnerable to: GHSA-4r62-v4vq-hr96
- Warn: Project is vulnerable to: GHSA-5v2h-r2cx-5xgj
- Warn: Project is vulnerable to: GHSA-rrrm-qjm4-v8hf
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-x7hr-w5r2-h6wg
- Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
- Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
Score
3.8
/10
Last Scanned on 2025-07-07
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More