README

A magical documentation site generator.



  
  
    
  
  
  
  


Gold Sponsor via Open Collective


  
    
  


Docsify turns one or more Markdown files into a Website, with no build process required.

 Features

- No statically built HTML files
- Simple and lightweight
- Smart full-text search plugin
- Multiple themes
- Useful plugin API
- Emoji support

 Quick Start

Get going fast by using a static web server or GitHub Pages with this ready-to-use Docsify Template, review the quick start tutorial or jump right into a CodeSandbox example site with the button below.



 Showcase

A large collection of showcase projects are included in awesome-docsify.

 Links

- Documentation
- Docsify CLI (Command Line Interface)
- CDN: UNPKG | jsDelivr | cdnjs
- develop branch preview
- Awesome docsify
- Community chat

 Contributing

See CONTRIBUTING.md.

 Backers

Thank you to all our backers! 🙏 [Become a backer]



 Sponsors

Thank you for supporting this project! ❤️ [Become a sponsor]



 Contributors

This project exists thanks to all the people who contribute. [Contribute].



 License

MIT