mirror of
https://github.com/docsifyjs/docsify.git
synced 2025-12-08 19:55:52 +00:00
38f2d243b8
Playwright had some in-range breaking changes (regressions): https://github.com/microsoft/playwright/issues/10819 and https://github.com/microsoft/playwright/issues/11570 Playwright tests need to `await onceRendered()` after each route navigation to wait for render to finish before testing the state of the rendered DOM. Tests were flaky because they were looking for DOM before render finished (sometimes). Additionally, this fixes one test that was failing only locally, but not in CI, due to a RegExp check against page.url() (not sure why it would differ on CI vs local, but now the URL is explicit).
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
- 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.
