archive-gh-me/docsify
1
0
Fork 0
mirror of https://github.com/docsifyjs/docsify.git synced 2025-12-08 19:55:52 +00:00
Code Issues Projects Releases Wiki Activity
docsify/docs/README.md
Paul Hibbitts 🍁 8fe0e1c0f1
docs: Update intro paragraph to help improve first impressions and broaden audience (#2602) 
Co-authored-by: Luffy <lufei@docsifyjs.org>
2025-09-28 10:43:05 +08:00

1.0 KiB
Raw Permalink Blame History

docsify

A magical documentation site generator.

What it is

Docsify turns your Markdown files into a documentation website instantly. Unlike most other documentation site generator tools, it doesn't need to build HTML files. Instead, it dynamically loads and parses your Markdown files and displays them as a website. To get started, create an index.html file and deploy it on GitHub Pages (for more details see the Quick start guide).

Features

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

Examples

Check out the Showcase to see docsify in use.

Donate

Please consider donating if you think docsify is helpful to you or that my work is valuable. I am happy if you can help me buy a cup of coffee. ❤️

Community

Users and the development team are usually in the Discord server.