proton-docs

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 (~21kB gzipped)
• 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

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 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

MIT