Markdown Manual

Markdown is a minimalistic way of formatting text for rendering in HTML. Originally conceived by John Gruber (see Markdown) it was quickly adopted by the developer community.
GitHub extended the syntax to include tables. The CommonMark foundation later standardized the syntax (see CommonMark).

NoteStack supports both "GitHub Flavored Markdown" and CommonMark.

Typography

_italic_ or *italic* renders italic
**bold** or __bold__ renders bold
~strikeout~ renders strikeout

Headers

# Heading 1 renders Heading 1
## Heading 2 renders Heading 2
etc.

Lists

- item 1
- item 2

Renders a bullet list

• item 1
• item 2

1. item 1
1. item 2

Renders a numbered list

1. item 1
2. item 2

Blockquotes

> Blockquotes renders, well

Blockquotes

Code blocks

`inline code`

renders inline code phrases.

Blocks of code can be rendered like so:

```javascript
function renderCodeBlock() {
  console.log('Renders code blocks')
}
```

A language can optionally be added to the block. Languages currently supported: javascript, java, typescript, bash, json, sql, dockerfile, python, ruby, handlebars, C++ ('cpp'), C# ('cs'), kotlin, swift.

function renderCodeBlock() {
  console.log('Renders code blocks')
}

Missing a language? Please submit a request in the feedback!

Links

An image tag consists of [<the text>](<the url>)

Sample:

[NoteStack - The Developer's Notebook](https://notestack.io)
renders to NoteStack - The Developer's Notebook

Images

When you drop an image or paste a screenshot into the editor NoteStack generates an image tag for you.
An image tag consists of ![<alt text>](<the url>)

Sample:

![Image](/api/file/a1acbfa8-f758-4f70-8605-fe77ad0668e6.png)

Turns into:

Tables

Tables require some ASCII-art. Pipes delimit columns. At least 3 dashes per column are required for the table to be recognized by the renderer. Colons can be used for alignment of the cells.

Sample:

|column 1|column 2|column 3|column 4|
|--------|-------|-------:|:---:|
|row 1 |left|right|center|

Turns into:

Horizontal rule

--- renders to

Raw HTML

It is possible to add HTML to a markdown document. Handle with care though! Faulty HTML can break the rendering of your document.