Markdown

These are the built in components that you’ll have access to simply by using markdown. The whitespace around these components is significant. If you encounter any errors, make sure you format the markdown and surounding space properly.

Text decoration

Emphasis, aka italics, with asterisks or underscores. Strong emphasis, aka bold, with asterisks or underscores. Combined emphasis with asterisks and underscores. Strikethrough uses two tildes. Scratch this.

Code

Emphasis, aka italics, with *asterisks* or _underscores_. Strong emphasis, aka bold, with **asterisks** or __underscores__. Combined emphasis with **asterisks and _underscores_**. Strikethrough uses two tildes. ~~Scratch this.~~

Headers

H1

Warning: The title located in each page header is an h1. Some resources suggest you should only have a single h1 per page, while others indicate it doesn’t matter. As a rule, we recommend using h2s as section headings for a consistent hierarchy.

H2

H3

H4

H5

Code

# H1 ## H2 ### H3 #### H4 ##### H5

Lists

  1. First ordered list item
  2. Another item
  3. Actual numbers don’t matter, just that it’s a number
  4. And another item.
  • Unordered list can use asterisks *
  • Or minuses - to create list items

Code

1. First ordered list item 2. Another item 3. Actual numbers don't matter, just that it's a number 4. And another item. - Unordered list can use asterisks `*` - Or minuses `-` to create list items

I’m a local link

I’m a markdown link

I’m a markdown link with title

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).

Code

[I'm a markdown link](https://www.carbondesignsystem.com) [I'm a markdown link with title](https://www.carbondesignsystem.com "Google's Homepage") [I'm a local link](/components/demo) 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.

Images

Alt text

Code

![Alt text](../../images/blossom.jpg)

Inline code and code blocks

Inline code has back-ticks around it.

Blocks of code have three back-ticks above and below

Code

Inline `code` has `back-ticks around` it. \``` Blocks have three back-ticks above and below. Pretend the backslashes aren't there. \```

Tables

Colons can be used to align columns.

TablesAreCool
col 3 isright-aligned1
col 2 iscentered2

There must be at least 3 dashes separating each header cell. The outer pipes (|) are optional, and you don’t need to make the raw Markdown line up prettily. You can also use inline Markdown.

MarkdownLessPretty
Stillrendersnicely
123

Code

Colons can be used to align columns. | Tables | Are | Cool | | ------------- |:-------------:| -----:| | col 3 is | right-aligned | $1600 | | col 2 is | centered | $12 | | zebra stripes | are neat | $1 | There must be at least 3 dashes separating each header cell. The outer pipes (|) are optional, and you don't need to make the raw Markdown line up prettily. You can also use inline Markdown. Markdown | Less | Pretty --- | --- | --- *Still* | `renders` | **nicely** 1 | 2 | 3

Blockquotes

This is a Blockquote This line is part of the same quote.

Code

> This is a Blockquote > This line is part of the same quote.