Skip to main content
live This is a new website – your feedback will help us to improve it.

Markdown for static websites

The basics

Back to top
To make ... Use ... to Get
Heading 1 (biggest) # Heading 1
Heading 1
Heading 2 ## Heading 2 Heading 2
Heading 3 ### Heading 3 Heading 3
Heading 4 #### Heading 4 Heading 4
Heading 5 ##### Heading 5 Heading 5
Heading 6 (smallest) ###### Heading 6 Heading 6
Italics *Italics* Italics
Bold **Bold** Bold
Linked text [Text to click](https://www.bas.ac.uk) Text to click
Paragraphs
(separate with at least 1 blank line)		 First paragraph

Second paragraph

First paragraph

Second paragraph
Bullet-point list * list item
  • list item
Numbered list 1. list item
2. list item
  1. list item
  2. list item
Definition list BAS
: British Antarctic Survey
BAS
British Antarctic Survey
Horizontal rule ---

The example headings used above use classes rather than header elements to prevent breaking the table of contents on this page. When the syntax given is used, heading elements will be produced.

Tables

Back to top
To make ... Use ... to Get
Standard table 
| Name       | Location                    |
| ---------- | --------------------------- |
| Ny-Ålesund | Svalbard, High Arctic       |
| Rothera    | Adelaide Island, Antarctica |
| Halley VI  | Brunt Ice Shelf, Antarctica |
{: .bsk-table .bsk-table-responsive }
Name Location
Ny-Ålesund Svalbard, High Arctic
Rothera Adelaide Island, Antarctica
Halley VI Brunt Ice Shelf, Antarctica
Table with borders 
| Name       | Location                    |
| ---------- | --------------------------- |
| Ny-Ålesund | Svalbard, High Arctic       |
| Rothera    | Adelaide Island, Antarctica |
| Halley VI  | Brunt Ice Shelf, Antarctica |
{: .bsk-table .bsk-table-bordered }
Name Location
Ny-Ålesund Svalbard, High Arctic
Rothera Adelaide Island, Antarctica
Halley VI Brunt Ice Shelf, Antarctica
Table with striped rows 
| Name       | Location                    |
| ---------- | --------------------------- |
| Ny-Ålesund | Svalbard, High Arctic       |
| Rothera    | Adelaide Island, Antarctica |
| Halley VI  | Brunt Ice Shelf, Antarctica |
{: .bsk-table .bsk-table-striped }
Name Location
Ny-Ålesund Svalbard, High Arctic
Rothera Adelaide Island, Antarctica
Halley VI Brunt Ice Shelf, Antarctica

Images

Back to top
To make ... Use ... to Get
Standard image - from the same website ![Image description...]({{'/img/placeholder-64.png' | prepend: site.baseurl }})
Linked image - from the same website [![Image description...]({{ '/img/placeholder-64.png' | prepend: site.baseurl }})](https://www.bas.ac.uk)
Standard image - from another website ![Image description...](https://style-kit.web.bas.ac.uk/img/placeholder-64.png)
Linked image - from another website [![Image description...](https://style-kit.web.bas.ac.uk/img/placeholder-64.png)](https://www.bas.ac.uk)

Block quotes / pull-outs

Back to top
To make ... Use ... to Get
Standard block quote > Any sufficiently advanced technology is indistinguishable from magic.
Any sufficiently advanced technology is indistinguishable from magic.
Block quote with citation
(URLs are optional)		 > Any sufficiently advanced technology is indistinguishable from magic.
> <footer markdown="1">Arthur C. Clarke from
> <cite title="Source Title">[Clarke's three laws](https://en.wikipedia.org/wiki/Clarke%27s_three_laws)</cite>
> </footer>

Any sufficiently advanced technology is indistinguishable from magic.

Code

Back to top
To make ... Use ... to Get
Inline code `var foo = 'bar';` var foo = 'bar';
Code block
(without syntax highlighting)		 ```
var foo = 'bar';
var baz = foo;
``` 
var foo = 'bar';
var baz = foo;
Keyboard input Press <kbd>ctrl</kbd> + <kbd>a</kbd> Press ctrl + a
Code output Output if successful: <samp>Complete: 12 records processed in 0.134 seconds</samp> Output if successful: Complete: 12 records processed in 0.1.34 seconds