diff --git a/guide/src/format/images/rust-logo-blk.svg b/guide/src/format/images/rust-logo-blk.svg new file mode 100644 index 00000000..1a6c762d --- /dev/null +++ b/guide/src/format/images/rust-logo-blk.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/guide/src/format/markdown.md b/guide/src/format/markdown.md new file mode 100644 index 00000000..b23c2a99 --- /dev/null +++ b/guide/src/format/markdown.md @@ -0,0 +1,34 @@ +# 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 +![The Rust Logo](images/rust-logo-blk.svg) +``` + +Produces the following HTML when built with mdBook: + +```html +

The Rust Logo

+``` + +Which, of course displays the image like so: + +![The Rust Logo](images/rust-logo-blk.svg) + +## Lists