mirror of
https://gitee.com/docsifyjs/docsify.git
synced 2024-11-30 02:58:37 +08:00
Migrated repository
d6df2b85a9
* fix: Cannot read property 'classList' of null * fix: Cannot read property classList of null https://github.com/docsifyjs/docsify/pull/1527#issuecomment-793455105 |
||
---|---|---|
.codesandbox | ||
.github | ||
.vscode | ||
build | ||
docs | ||
packages/docsify-server-renderer | ||
src | ||
test | ||
.editorconfig | ||
.eslintignore | ||
.eslintrc.js | ||
.gitignore | ||
.gitpod.yml | ||
.npmignore | ||
.prettierrc.js | ||
babel.config.js | ||
CHANGELOG.md | ||
CONTRIBUTING.md | ||
HISTORY.md | ||
index.html | ||
jest.config.js | ||
lerna.json | ||
LICENSE | ||
package-lock.json | ||
package.json | ||
README.md | ||
server.js |
A magical documentation site generator.
Gold Sponsor via Open Collective
Links
develop
branch 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
- Support SSR (example)
- Support embedded files
Quick start
Look at this tutorial
Showcase
These projects are using docsify to generate their sites. Pull requests welcome 😊
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 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
Vercel has given us a Pro account.