Mermaid generates diagrams such as flowcharts, sequence diagrams and Gantt charts from Markdown-like text definitions.
90.8K9.4KTypeScriptMITUpdated 9 hours ago
docsifyjs/docsify
A documentation site generator that turns Markdown files into a website with no build step required.
- Stars
- 31,556
- Forks
- 5,784
- Open issues
- 102
- Last commit
- 3 hours ago
What is it?
Docsify turns one or more Markdown files into a documentation website without generating static HTML files at build time. Pages are rendered in the browser, so you can write content in Markdown, serve the folder from any static web server or GitHub Pages, and see the site without a compile step.
The project is lightweight and offers a full-text search plugin, several built-in themes, emoji support, and a plugin API for extending the site. A separate Docsify CLI is available, and the library can be loaded from common CDNs such as UNPKG, jsDelivr and cdnjs.
Docsify is a good fit for project documentation that needs to stay in the same repository as the code and be updated by editing Markdown directly.
Key features
- 01Renders Markdown files into a website without a build step
- 02Works with any static web server or GitHub Pages
- 03Includes a full-text search plugin
- 04Offers multiple built-in themes
- 05Provides a plugin API for customization
- 06Supports emoji
Use cases
- Hosting project documentation alongside source code in a Git repository
- Publishing a documentation site on GitHub Pages without a static site generator pipeline
- Quickly building a internal knowledge base from existing Markdown notes
Quick start
- 1
Use the ready-to-use Docsify Template on GitHub and serve it with a static web server or GitHub Pages
- 2
Read the quick start tutorial on the official docs site
Topics
FAQ
- What is docsify?
- A documentation site generator that turns Markdown files into a website with no build step required. Docsify turns one or more Markdown files into a documentation website without generating static HTML files at build time. Pages are rendered in the browser, so you can write content in Markdown, serve the folder from any static web server or GitHub Pages, and see the site without a compile step.
- Is docsify free to use? What license does it have?
- docsify is open source under the MIT license. Check the license terms before using it in commercial products.
- Is docsify still maintained?
- Actively maintained. The last commit to docsify was on Oct 21, 2026.
- What can I use docsify for?
- Hosting project documentation alongside source code in a Git repository Publishing a documentation site on GitHub Pages without a static site generator pipeline Quickly building a internal knowledge base from existing Markdown notes
- How do I install docsify?
- Use the ready-to-use Docsify Template on GitHub and serve it with a static web server or GitHub Pages Read the quick start tutorial on the official docs site
- Where can I get docsify?
- The source code and installation instructions are on GitHub: https://github.com/docsifyjs/docsify
Summary generated by AI from the project's README. GitHub stats refresh daily.
Related projects
A scaffolder that generates an editable Astro documentation site into your repo, with agent-readable Markdown and llms.txt output built in.
1.4K52TypeScriptMITUpdated 2 days ago
An opinionated code formatter that re-prints JavaScript, TypeScript, CSS, HTML, Markdown, YAML and more to a consistent style.
52.4K5KJavaScriptMITUpdated yesterday
A terminal markdown reader and renderer that displays .md files and repos with styled formatting in the CLI.
27.7K890GoMITUpdated 16 days ago
A Rust-based static site generator for Markdown documentation, from the team behind Material for MkDocs.
6K134RustMITUpdated 2 days ago
A Markdown documentation compiler that turns one source folder into a static docs website, offline search, llms.txt, and AI-agent context.
2.5K144TypeScriptMITUpdated 4 days ago