A magical documentation generator.
Package: docsify
Created by: docsifyjs
Last modified: Sat, 24 Jun 2023 07:28:25 GMT
Version: 4.13.1
License: MIT
Downloads: 237,517
Repository: https://github.com/docsifyjs/docsify
Install
npm install docsify
yarn add docsify
A magical documentation site generator.
Gold Sponsor via Open Collective
Links
developbranch preview- Documentation
- CLI
- CDN: UNPKG | jsDelivr | cdnjs
- Awesome docsify
- Community chat
Features
- No statically built html files
- Simple and lightweight
- Smart full-text search plugin
- Multiple themes
- Useful plugin API
- Compatible with IE11
- Experimental SSR support (example)
- Support embedded files
Quick start
Look at this tutorial
Showcase
These projects are using docsify to generate their sites. Pull requests welcome :blush:
Move to awesome-docsify
Similar projects
| Project | Description |
|---|---|
| docute | 📜 Effortlessly documentation done right |
| docpress | Documentation website generator |
Contributing
Online one-click setup for Contributing
You can use Gitpod (a free online VS Code-like IDE) for contributing. With a single click it'll launch a workspace and automatically:
- clone the docsify repo.
- install the dependencies.
- start
npm run dev.
So that you can start straight away.
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature - Commit your changes:
git add . && git commit -m 'Add some feature' - Push to the branch:
git push origin my-new-feature - Submit a pull request
Development
npm run bootstrap && npm run dev
Backers
Thank you to all our backers! 🙏 [Become a backer]
Sponsors
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]
Contributors
This project exists thanks to all the people who contribute. [Contribute].
License
Special Thanks
A preview of Docsify's PR and develop branch is Powered by 
Dependencies
Dependencies
@babel/core: ^7.11.6@babel/eslint-parser: ^7.16.5@babel/preset-env: ^7.11.5@playwright/test: ^1.18.1autoprefixer-stylus: ^1.0.0axios: ^0.21.1babel-jest: ^27.4.6browser-sync: ^2.26.12chokidar: ^3.4.2common-tags: ^1.8.0conventional-changelog-cli: ^2.1.0copy-dir: ^1.2.0cross-env: ^6.0.3cssnano: ^4.1.10eslint: ^8.7.0eslint-config-prettier: ^8.3.0eslint-plugin-import: ^2.20.1eslint-plugin-jest: ^26.0.0eslint-plugin-playwright: ^0.8.0eslint-plugin-prettier: ^4.0.0husky: ^3.1.0jest: ^27.4.7lerna: ^5.5.1lint-staged: ^10.4.0live-server: ^1.2.1mkdirp: ^0.5.1npm-run-all: ^4.1.5prettier: ^2.5.1rimraf: ^3.0.0rollup: ^1.23.1rollup-plugin-async: ^1.2.0rollup-plugin-buble: ^0.19.8rollup-plugin-commonjs: ^10.1.0rollup-plugin-node-resolve: ^5.2.0rollup-plugin-replace: ^2.2.0rollup-plugin-uglify: ^6.0.4serve-handler: ^6.1.2stylus: ^0.54.5vue2: npm:vue@^2.6.12vue3: npm:vue@^3.0.0xhr-mock: ^2.5.1
