mirror of
https://github.com/docsifyjs/docsify.git
synced 2025-12-08 19:55:52 +00:00
This PR restores the task list presentation removed in 4.8: - Add “task-list-item” class to task list `<li>` elms - Hide list bullets on unordered task lists `<li>` elms It also provides several improvements on the pre-4.8 presentation: - Add “task-list” class to task list `<ul>` elms - Display list numbers on ordered task lists `<li>` elms - Render accessible task list items by wrapping checkbox and text in `<label>` elm - Allow task lists to be nested within standard ordered/unordered lists Please makes sure these boxes are checked before submitting your PR, thank you! * [x] Make sure you are merging your commits to `master` branch. * [x] Add some descriptions and refer relative issues for you PR. * [x] DO NOT include files inside `lib` directory.
A magical documentation site generator.
Gold Sponsor via Open Collective
Links
Features
- No statically built html files
- Simple and lightweight (~21kB gzipped)
- Smart full-text search plugin
- Multiple themes
- Useful plugin API
- Compatible with IE10+
- 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
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature - Commit your changes:
git commit -am '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
Languages
JavaScript
86.8%
CSS
12.5%
TypeScript
0.3%
Shell
0.2%
HTML
0.2%