Headings
Headings from h1
through h6
are constructed with a #
for each level:
# h1 Heading
## h2 Heading
### h3 Heading
#### h4 Heading
##### h5 Heading
###### h6 Heading
Renders to:
h1 Heading
h2 Heading
h3 Heading
h4 Heading
h5 Heading
h6 Heading
HTML:
<h1>h1 Heading</h1>
<h2>h2 Heading</h2>
<h3>h3 Heading</h3>
<h4>h4 Heading</h4>
<h5>h5 Heading</h5>
<h6>h6 Heading</h6>
Comments
Comments should be HTML compatible
<!--
This is a comment
-->
Comment below should NOT be seen:
Horizontal Rules
The HTML <hr>
element is for creating a "thematic break" between paragraph-level elements. In markdown, you can create a <hr>
with any of the following:
___
: three consecutive underscores
---
: three consecutive dashes
***
: three consecutive asterisks
renders to:
Body Copy
Body copy written as normal, plain text will be wrapped with <p></p>
tags in the rendered HTML.
So this body copy:
Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.
renders to this HTML:
<p>Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.</p>
Emphasis
Bold
For emphasizing a snippet of text with a heavier font-weight.
The following snippet of text is rendered as bold text.
**rendered as bold text**
renders to:
rendered as bold text
and this HTML
<strong>rendered as bold text</strong>
Italics
For emphasizing a snippet of text with italics.
The following snippet of text is rendered as italicized text.
_rendered as italicized text_
renders to:
rendered as italicized text
and this HTML:
<em>rendered as italicized text</em>
strikethrough
In GFM (GitHub flavored Markdown) you can do strikethroughs.
~~Strike through this text.~~
Which renders to:
Strike through this text.
HTML:
<del>Strike through this text.</del>
Images
Posted on
08/07/2025 12:25PM
Images have a similar syntax to links but include a preceding exclamation point.

or

Like links, Images also have a footnote style syntax

Renders to (hover over the link, there is no tooltip):
Assemble
HTML:
Assemble
Add a title
[Upstage](https://github.com/upstage/ "Visit Upstage!")
Renders to (hover over the link, there should be a tooltip):...
Tables
Posted on
08/07/2025 12:26PM
Tables are created by adding pipes as dividers between each cell, and by adding a line of dashes (also separated by bars) beneath the header. Note that the pipes do not need to be vertically aligned.
| Option | Description |
| ------ | ----------- |
| data | path to data files to supply the data...
Code
Posted on
08/07/2025 12:26PM
Inline code
Wrap inline snippets of code with `.
In this example, `` should be wrapped as **code**.
Renders to:
In this example, should be wrapped with code.
HTML:
In this example, <section></section> should be wrap...