Roadmap uses Markdown for formatting content in roadmap stories. Markdown is a lightweight formatting language for adding things like headers, bulleted lists, code blocks, and more. View an entire Markdown syntax and expanded cheat sheet here.
Markdown in Roadmap
Markdown is not supported in titles for Roadmap stories or for internal roadmap stories. Currently, we do not support tables or embedded videos (use a GIF!).
Emphasis
Emphasis, aka italics, with asterisks or underscore.
Strong emphasis, aka bold, with asterisks or underscore.
Combined emphasis with asterisks and underscore.
Strikethrough uses two tildes. Scratch this.
Examples
Emphasis, aka italics, with *asterisks* or _underscore_.
Strong emphasis, aka bold, with **asterisks** or __underscore__.
Combined emphasis with **asterisks and _underscore_**.
Strikethrough uses two tildes. ~~Scratch this~~.
Lists
- First ordered list item.
- Another itemUnordered sub-list.
- Actual numbers don’t matter, just that it’s a numberOrdered sub-list
- And another item.
Some text that should be aligned with the above item.
- Unordered list can use asterisks
- Or minuses
- Or pluses
Examples
1. First ordered list item.
2. Another itemUnordered sub-list.
1. Actual numbers don’t matter, just that it’s a numberOrdered sub-list
4. And another item. <br>Some text that should be aligned with the above item.
* Unordered list can use asterisks
- Or minuses
+ Or pluses
Links
There are two ways to create links.
You can use numbers for reference-style link definitions
Or leave it empty and use the link text itself.
URLs and URLs in angle brackets will automatically get turned into links. http://www.example.com or http://www.example.com and sometimes example.com (but not on Github, for example).
Some text to show that the reference links can follow later.
[I'm an inline-style link](https://www.google.com)
[I'm a reference-style link][Arbitrary case-insensitive reference text]
[You can use numbers for reference-style link definitions][1]
Or leave it empty and use the [link text itself].
URLs and URLs in angle brackets will automatically get turned into links.
http://www.example.com or <http://www.example.com> and sometimes
example.com (but not on Github, for example).
Some text to show that the reference links can follow later.
[arbitrary case-insensitive reference text]: https://www.mozilla.org
[1]: http://slashdot.org
[link text itself]: http://www.reddit.com
Images
Here’s our logo (hover to see the title text):
Big thanks to Adam Pritchard for letting us use his handy guide to Markdown.