Skip to content
This repository has been archived by the owner on Feb 5, 2024. It is now read-only.

Markdown cheatsheet

Alison Joseph edited this page Jul 19, 2019 · 4 revisions

This is a page template that you can use to style a new page to the Carbon Design System website.

Heading & paragraph styles

This is the styling for the bold intro paragraph at the top of the page. This item is blue.

## This generates an H2 heading 

### This generates an H3 heading 

#### This generates an H4 heading. 

**This is bold text.**

_This is italic text or an image caption._ 

This is a normal paragraph with a [link](http://www.link.com).

> This is a block quote.

This generates an H2 heading

This generates an H3 heading

This generates an H4 heading.

This is bold text.

This is italic text or an image caption.

This is a normal paragraph with a link.

This is a block quote.

Images

New image component

<image-component cols="8" caption="Enter caption here">

![image alt text](/images/image1.png)

</image-component>

This generates an image:

![image alt text](images/image.png)

Use this syntax for grouped images (2 in a row or 3 in a row):

**
![image alt text](images/image.png)
![image alt text](images/image.png)
**

**
![image alt text](images/image.png)
![image alt text](images/image.png)
![image alt text](images/image.png)
**

Use this syntax for overlay images:

_
![image alt text](images/image.png)
_

Lists

* This is a bulleted list
* List item 2 
  • This is a bulleted list
  • List item 2

Tables

| COL 1      | COL 2   |  COL 3     |
|------------|---------|------------|
| Row 1A     | Row 1B  | Row 1C     | 
| Row 2A     | Row 2B  | Row 2C     | 
| Row 3A     | Row 3B  | Row 3C     | 

You can reference this table generator for easy table creation.

Code & syntax highlighting

We support inline code and code blocks.

Inline `code` has `back-ticks around` it.


```
Blocks of code are fenced by lines with three back-ticks 

``` 

Inline code has back-ticks around it.

Blocks of code are fenced by lines with three back-ticks