{"id":13473908,"url":"https://github.com/docsifyjs/docsify-cli","last_synced_at":"2026-01-12T05:40:52.763Z","repository":{"id":13529493,"uuid":"74482617","full_name":"docsifyjs/docsify-cli","owner":"docsifyjs","description":"🖌 docsify cli tool - A magical documentation generator.","archived":false,"fork":false,"pushed_at":"2025-10-17T08:56:16.000Z","size":1482,"stargazers_count":756,"open_issues_count":22,"forks_count":162,"subscribers_count":19,"default_branch":"master","last_synced_at":"2025-11-20T20:04:22.854Z","etag":null,"topics":["docsify","docsify-cli","javascript","nodejs"],"latest_commit_sha":null,"homepage":"https://cli.docsifyjs.org","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/docsifyjs.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":["docsifyjs","sy-records"],"open_collective":"docsify"}},"created_at":"2016-11-22T14:50:41.000Z","updated_at":"2025-11-15T22:26:08.000Z","dependencies_parsed_at":"2022-08-07T07:15:29.303Z","dependency_job_id":"cce3eece-6329-4a23-9b34-36fca435b34b","html_url":"https://github.com/docsifyjs/docsify-cli","commit_stats":{"total_commits":265,"total_committers":28,"mean_commits":9.464285714285714,"dds":0.6075471698113207,"last_synced_commit":"c74c3d280b2c70b20bd8176e021ee78ec4e5bcdf"},"previous_names":["qingwei-li/docsify-cli"],"tags_count":53,"template":false,"template_full_name":null,"purl":"pkg:github/docsifyjs/docsify-cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docsifyjs%2Fdocsify-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docsifyjs%2Fdocsify-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docsifyjs%2Fdocsify-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docsifyjs%2Fdocsify-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/docsifyjs","download_url":"https://codeload.github.com/docsifyjs/docsify-cli/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docsifyjs%2Fdocsify-cli/sbom","scorecard":{"id":115665,"data":{"date":"2025-08-11","repo":{"name":"github.com/docsifyjs/docsify-cli","commit":"0f01e4bc26ca7902b4bfa34b27655c95d2681c1e"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4.9,"checks":[{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Code-Review","score":4,"reason":"Found 6/14 approved changesets -- score normalized to 4","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":3,"reason":"4 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 3","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Token-Permissions","score":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"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Pinned-Dependencies","score":3,"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"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Security-Policy","score":10,"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"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 26 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-16T01:13:00.308Z","repository_id":13529493,"created_at":"2025-08-16T01:13:00.308Z","updated_at":"2025-08-16T01:13:00.308Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28335226,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-12T00:36:25.062Z","status":"online","status_checked_at":"2026-01-12T02:00:08.677Z","response_time":98,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docsify","docsify-cli","javascript","nodejs"],"created_at":"2024-07-31T16:01:07.924Z","updated_at":"2026-01-12T05:40:52.759Z","avatar_url":"https://github.com/docsifyjs.png","language":"JavaScript","readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://docsify.js.org\"\u003e\n    \u003cimg alt=\"docsify\" src=\"./media/icon.svg\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n 🖌 docsify cli - A magical documentation generator.\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"#backers\"\u003e\u003cimg alt=\"Backers on Open Collective\" src=\"https://opencollective.com/docsify/backers/badge.svg?style=flat-square\"\u003e\u003c/a\u003e\n  \u003ca href=\"#sponsors\"\u003e\u003cimg alt=\"Sponsors on Open Collective\" src=\"https://opencollective.com/docsify/sponsors/badge.svg?style=flat-square\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://www.npmjs.com/package/docsify\"\u003e\u003cimg alt=\"npm\" src=\"https://img.shields.io/npm/v/docsify-cli.svg?style=flat-square\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/docsifyjs/docsify-cli/actions\"\u003e\u003cimg alt=\"Github Actions Status\" src=\"https://github.com/docsifyjs/docsify-cli/workflows/docsify-cli/badge.svg\"\u003e\u003c/a\u003e\n\u003ca href=\"https://discord.gg/3NwKFyR\"\u003e\u003cimg alt=\"Join Discord community and chat about Docsify\" src=\"https://img.shields.io/discord/713647066802421792.svg?label=\u0026logo=discord\u0026logoColor=ffffff\u0026color=7389D8\u0026labelColor=6A7EC2\u0026cacheSeconds=60\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/docsifyjs/docsify-cli/blob/master/LICENSE\"\u003e\u003cimg alt=\"license\" src=\"https://img.shields.io/github/license/docsifyjs/docsify-cli.svg?style=flat-square\"\u003e\u003c/a\u003e\n\u003ca href=\"https://www.npmjs.com/package/docsify-cli\"\u003e\u003cimg alt=\"npm-total-download\" src=\"https://img.shields.io/npm/dt/docsify-cli.svg?style=flat-square\"\u003e\u003c/a\u003e\n\u003ca href=\"https://www.npmjs.com/package/docsify-cli\"\u003e\u003cimg alt=\"npm-monthly-download\" src=\"https://img.shields.io/npm/dm/docsify-cli.svg?style=flat-square\"\u003e\u003c/a\u003e\n\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003eGold Sponsor via \u003ca href=\"https://opencollective.com/docsify\"\u003eOpen Collective\u003c/a\u003e\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://opencollective.com/docsify/order/3254\"\u003e\n    \u003cimg src=\"https://opencollective.com/docsify/tiers/gold-sponsor.svg?avatarHeight=36\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n## Screencast\n\n![Screencast](https://raw.githubusercontent.com/docsifyjs/docsify-cli/master/media/screencast.gif)\n\n\u003e Running a server on `localhost` with live-reload.\n\n## Installation\n\nInstall `docsify-cli` via `npm` or `yarn` globally.\n\n```shell\nnpm i docsify-cli -g\n# yarn global add docsify-cli\n```\n\n## Usage\n\n### `init` command\n\nUse `init` to generate your docs.\n\n```shell\ndocsify init [path] [--local false] [--rcMode] [--theme vue] [--plugins]\n\n# docsify i [path] [-l false] [--rc] [-t vue] [-p]\n```\n\n`[path]` defaults to the current directory. Use relative paths like `./docs` (or `docs`).\n\n- `--local` option:\n  - Shorthand: `-l`\n  - Type: boolean\n  - Default: `false`\n  - Description: Copy `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`.\n- `--rcMode` option:\n  - Shorthand: `--rc`\n  - Type: boolean\n  - Default: `false`\n  - Description: Try `docsify` preview release version (`rc` resource).\n- `--theme` option:\n  - Shorthand: `-t`\n  - Type: string\n  - Default: `vue`\n  - Description: Choose a theme, defaults to `vue`.\n- `--plugins` option:\n  - Shorthand: `-p`\n  - Type: boolean\n  - Default: `false`\n  - Description: Provide a list of plugins to insert as `\u003cscript\u003e` tags to `index.html`.\n\n### `serve` command\n\nRun a server on `localhost` with livereload.\n\n```shell\ndocsify serve [path] [--open false] [--port 3000]\n\n# docsify s [path] [-o false] [-p 3000]\n```\n\n- `--open` option:\n  - Shorthand: `-o`\n  - Type: boolean\n  - Default: `false`\n  - Description: Open the docs in the default browser, defaults to `false`. To explicitly set this option to `false` use `--no-open`.\n- `--port` option:\n  - Shorthand: `-p`\n  - Type: number\n  - Default: `3000`\n  - Description: Choose a listen port, defaults to `3000`.\n- `--host` option:\n  - Shorthand: `-H`\n  - Type: string\n  - Default: `localhost`\n  - Description: Choose a host to bind to, defaults to `localhost`.\n\n### `generate` command\n\nDocsify's generators.\n\n```shell\ndocsify generate [path] [--sidebar _sidebar.md] [--overwrite]\n\n# docsify g [path] [-s _sidebar.md] [-o]\n```\n\n- `--sidebar` option:\n  - Shorthand: `-s`\n  - Type: string\n  - Default: `_sidebar.md`\n  - Description: Generate sidebar file, defaults to `_sidebar.md`.\n\n- `--overwrite` option:\n  - Shorthand: `-o`\n  - Type: boolean\n  - Default: `false`\n  - Description: Allow to overwrite generated files.\n\n## Contributing\nPlease see the [Contributing Guidelines](./CONTRIBUTING.md)\n\n## Contribution\n\n[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/docsifyjs/docsify-cli)\n\n## License\n\n[MIT](LICENSE)\n","funding_links":["https://github.com/sponsors/docsifyjs","https://github.com/sponsors/sy-records","https://opencollective.com/docsify","https://opencollective.com/docsify/order/3254"],"categories":["JavaScript","nodejs"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocsifyjs%2Fdocsify-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdocsifyjs%2Fdocsify-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocsifyjs%2Fdocsify-cli/lists"}