Docsify Markdown: Complete Guide
Docsify is a lightweight documentation site generator that renders markdown files directly in the browser with no build step. Just create markdown files and serve them. Docsify parses markdown on the fly, supports plugins, and provides features like search, themes, and sidebar navigation.
Markdown support:GFM
Markdown Support in Docsify
| Format | Syntax | Support |
|---|---|---|
| Bold | **text** | Yes |
| Italic | *text* | Yes |
| Strikethrough | ~~text~~ | Yes |
| Headings | # H1 ... ###### H6 | Yes |
| Links | [text](url) | Yes |
| Images |  | Yes |
| Blockquotes | > quote | Yes |
| Ordered Lists | 1. item | Yes |
| Unordered Lists | - item | Yes |
| Code (inline) | `code` | Yes |
| Code Blocks | ```lang\ncode\n``` | Yes |
| Tables | | col | col | | Yes |
| Task Lists | - [ ] task | Yes |
| Footnotes | [^1] | No Not supported by default |
| Horizontal Rule | --- | Yes |
Things to know
- No build step required. Markdown files are parsed and rendered in the browser at runtime.
- Uses marked.js as the markdown parser.
- Custom sidebar and navbar are configured via separate markdown files.
- Plugins extend functionality (search, copy code, pagination, etc.).
Frequently Asked Questions
Does Docsify support markdown?
Yes. Docsify renders markdown files directly in the browser using marked.js. It supports GFM-compatible syntax including headings, bold, italic, links, images, code blocks, and tables.
How do you bold text in Docsify?
Use standard markdown syntax: **bold text**. Docsify parses your markdown at runtime in the browser and renders the formatted output.
Does Docsify require a build step?
No. Docsify parses markdown files at runtime in the browser. You just create .md files, add an index.html with the Docsify script, and serve the files.
Is Docsify free?
Yes. Docsify is free and open source. You can host your documentation anywhere that serves static files, including GitHub Pages.