GitBook Markdown: Complete Guide
GitBook is a modern documentation platform that supports markdown for writing docs. It provides a visual editor with markdown shortcuts, Git-based sync, and collaboration features. GitBook supports GFM syntax and adds its own content blocks like hints, tabs, and embeds.
Markdown support:GFM
Markdown Support in GitBook
| 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 Rendered as interactive checkboxes |
| Footnotes | [^1] | No Not supported |
| Horizontal Rule | --- | Yes |
Things to know
- Uses a visual editor with markdown shortcuts, not a raw markdown editor.
- Supports custom content blocks like hints, tabs, and API references.
- Can sync content from a GitHub or GitLab repository.
- Markdown files imported from Git are converted to GitBook's internal format.
Frequently Asked Questions
Does GitBook support markdown?
Yes. GitBook supports GFM-compatible markdown including headings, bold, italic, links, images, code blocks, tables, and task lists. You can type markdown shortcuts in the editor or sync from a Git repository.
How do you bold text in GitBook?
Type **bold text** in the editor and GitBook will format it as bold. You can also use Ctrl/Cmd + B or select text and use the toolbar.
Can GitBook sync with GitHub?
Yes. GitBook offers bi-directional Git sync with GitHub and GitLab. Changes in your repository are reflected in GitBook and vice versa.
Does GitBook support code blocks?
Yes. GitBook supports fenced code blocks with syntax highlighting for many programming languages. Use triple backticks with a language identifier.