mdBook's parser adheres to the CommonMark specification with some extensions described below. You can take a quick tutorial, or try out CommonMark in real time. A complete Markdown overview is out of scope for this documentation, but below is a high level overview of some of the basics. For a more in-depth experience, check out the Markdown Guide.
Text is rendered relatively predictably:
Here is a line of text. This is a new line.
Will look like you might expect:
Here is a line of text.
This is a new line.
Headings use the
# marker and should be on a line by themselves. More
# mean smaller headings:
### A heading Some text. #### A smaller heading More text.
Lists can be unordered or ordered. Ordered lists will order automatically:
* milk * eggs * butter 1. carrots 1. celery 1. radishes
Linking to a URL or local file is easy:
Use [mdBook](https://github.com/rust-lang/mdBook). Read about [mdBook](mdBook.md). A bare url: <https://www.rust-lang.org>.
Read about mdBook.
A bare url: https://www.rust-lang.org.
Relative links that end with
.md will be converted to the
It is recommended to use
.md links when possible.
This is useful when viewing the Markdown file outside of mdBook, for example on GitHub or GitLab which render Markdown automatically.
README.md will be converted to
This is done since some services like GitHub render README files automatically, but web servers typically expect the root file to be called
You can link to individual headings with
mdbook.md#text-and-paragraphs would link to the Text and Paragraphs section above.
The ID is created by transforming the heading such as converting to lowercase and replacing spaces with dashes.
You can click on any heading and look at the URL in your browser to see what the fragment looks like.
Including images is simply a matter of including a link to them, much like in the Links section above. The following markdown
includes the Rust logo SVG image found in the
images directory at the same level as this file:
![The Rust Logo](images/rust-logo-blk.svg)
Produces the following HTML when built with mdBook:
<p><img src="images/rust-logo-blk.svg" alt="The Rust Logo" /></p>
Which, of course displays the image like so:
mdBook has several extensions beyond the standard CommonMark specification.
Text may be rendered with a horizontal line through the center by wrapping the text with two tilde characters on each side:
An example of ~~strikethrough text~~.
This example will render as:
An example of
This follows the GitHub Strikethrough extension.
A footnote generates a small numbered link in the text which when clicked takes the reader to the footnote text at the bottom of the item. The footnote label is written similarly to a link reference with a caret at the front. The footnote text is written like a link reference definition, with the text following the label. Example:
This is an example of a footnote[^note]. [^note]: This text is the contents of the footnote, which will be rendered towards the bottom.
This example will render as:
This is an example of a footnote1.1
This text is the contents of the footnote, which will be rendered towards the bottom.
The footnotes are automatically numbered based on the order the footnotes are written.
Tables can be written using pipes and dashes to draw the rows and columns of the table. These will be translated to HTML table matching the shape. Example:
| Header1 | Header2 | |---------|---------| | abc | def |
This example will render similarly to this:
See the specification for the GitHub Tables extension for more details on the exact syntax supported.
Task lists can be used as a checklist of items that have been completed. Example:
- [x] Complete task - [ ] Incomplete task
This will render as:
- Complete task
- Incomplete task
See the specification for the task list extension for more details.
Some ASCII punctuation sequences will be automatically turned into fancy Unicode characters:
|“ or ”, depending on context|
|‘ or ’, depending on context|
So, no need to manually enter those Unicode characters!
This feature is disabled by default.
To enable it, see the
output.html.curly-quotes config option.