35 lines
1.1 KiB
Markdown
35 lines
1.1 KiB
Markdown
|
# Markdown
|
||
|
|
|
||
|
|
mdBook's [parser](https://github.com/raphlinus/pulldown-cmark) adheres to the [CommonMark](https://commonmark.org/)
|
||
|
|
specification. You can take a quick [tutorial](https://commonmark.org/help/tutorial/),
|
||
|
|
or [try out](https://spec.commonmark.org/dingus/) 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](https://www.markdownguide.org).
|
||
|
|
|
||
|
|
## Text and Paragraphs
|
||
|
|
|
||
|
|
## Titles
|
||
|
|
|
||
|
|
## Links
|
||
|
|
|
||
|
|
## Images
|
||
|
|
|
||
|
|
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:
|
||
|
|
|
||
|
|
```markdown
|
||
|
|
|
||
|
|
```
|
||
|
|
|
||
|
|
Produces the following HTML when built with mdBook:
|
||
|
|
|
||
|
|
```html
|
||
|
|
<p><img src="images/rust-logo-blk.svg" alt="The Rust Logo" /></p>
|
||
|
|
```
|
||
|
|
|
||
|
|
Which, of course displays the image like so:
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
## Lists
|