2022-10-26 21:50:32 +08:00
2021-12-10 01:55:30 +08:00
2017-12-16 12:06:12 +08:00
2022-01-16 19:52:18 -08:00
2021-09-10 13:57:38 +08:00

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

Showcase

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

Similar Projects

Project Description
Docusaurus Docusaurus makes it easy to maintain Open Source documentation websites
MkDocs Project documentation with Markdown
VitePress Vite & Vue Powered Static Site Generator

Contributing

See CONTRIBUTING.md.

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

Special Thanks

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

Description
🃏 A magical documentation site generator.
Readme MIT 70 MiB
Languages
JavaScript 86.8%
CSS 12.5%
TypeScript 0.3%
Shell 0.2%
HTML 0.2%