/Docsify

🃏 A magical documentation site generator.

Primary LanguageJavaScriptMIT LicenseMIT

Docsify

A magical documentation site generator.

Backers On Open Collective Sponsors On Open Collective Build & Test NPM Donate Join Discord Community And Chat About Docsify Gitpod Ready-To-Code

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
  • Support embedded files

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.

Edit In CodeSandbox

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

    Backers

    Sponsors

    Thank you for supporting this project！:heart: Become A Sponsor

    Sponsors

    Contributors

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

    License

    MIT

    Special Thanks

    A preview of Docsify's PR and develop branch is Powered By Vercel