Markdown Syntax

How To Use the Syntax!

This is a guide for what Markdown and HTML syntax the app currently supports.

Headings

Markdown	HTML	Rendered Output
# Heading 1	<h1>Heading 1</h1>	Heading 1
## Heading 2	<h2>Heading 2</h2>	Heading 2
### Heading 3	<h3>Heading 3</h3>	Heading 3
#### Heading 4	<h4>Heading 4</h4>	Heading 4

Emphasis

Bold

Markdown	HTML	Rendered Output
This is **bold**	This is <strong>bold</strong>	This is bold
Another way to __bold__	Another way to <strong>bold</strong>	Another way to bold

Italic

Markdown	HTML	Rendered Output
This is *italicized*	This is <em>italicized</em>	This is italicized
Another way to _italicized_	Another way to <em>italicized</em>	Another way to italicized

Highlight

Markdown	Rendered Output
How to ==Highlight==	How to Highlight

Strikethrough

Markdown	Rendered Output
How to ~~Strikethrough~~	How to Strikethrough

Blockquotes

Single Quote

Text:

> Peter Piper picked a peck of pickled peppers

Rendering:

Peter Piper picked a peck of pickled peppers

Multiline Quotes

Text:

> Peter Piper picked a peck of pickled peppers`
>
> A peck of pickled peppers Peter Piper picked.`

Rendering:

Peter Piper picked a peck of pickled peppers

A peck of pickled peppers Peter Piper picked.

Use <br/> to force break quote to the next line

> Peter Piper picked a peck of pickled peppers<br/>
> A peck of pickled peppers Peter Piper picked.

Peter Piper picked a peck of pickled peppers
A peck of pickled peppers Peter Piper picked.

Otherwise, it would look like this:

Peter Piper picked a peck of pickled peppers A peck of pickled peppers Peter Piper picked.

Nested Quotes

Text:

> Peter Piper picked a peck of pickled peppers
>
> A peck of pickled peppers Peter Piper picked.
>
> If Peter Piper picked a peck of pickled peppers,
>
>> Where's the peck of pickled peppers that Peter Piper picked?

Rendering:

Peter Piper picked a peck of pickled peppers

A peck of pickled peppers Peter Piper picked.

If Peter Piper picked a peck of pickled peppers,

Where's the peck of pickled peppers that Peter Piper picked?

Lists

Unordered List

Markdown	HTML	Rendered Output
- First item - Second item	<ul> <li>First item</li> <li>Second item</li> </ul>	First item Second item
* First item * Second item	<ul> <li>First item</li> <li>Second item</li> </ul>	First item Second item
- First item - Indented item - Second item	<ul> <li>First item</li> <ul> <li>Indented item</li> </ul> <li>Second item</li> </ul>	First item Indented item Second item

Ordered List

Markdown	HTML	Rendered Output
1. First item 2. Second item	<ol> <li>First item</li> <li>Second item</li> </ol>	First item Second item
1. First item 1. Indented item 2. Second item	<ol> <li>First item</li> <ol> <li>Indented item</li> </ol> <li>Second item</li> </ol>	First item Indented item Second item

Checkboxes

For an unchecked checkbox, use - [ ]:

• Unchecked

For checked checkboxes, use - [x]:

• Checked

Code and Code Blocks

You can use single backticks (`) on either `side` to wrap code or you can use three to make code blocks

Add coding language in front of the first three backticks for code syntax styles.

Text:

```Dart
import 'package:flutter/material.dart';

class HomePage extends StatelessWidget {
}
```

Rendering:

import 'package:flutter/material.dart';

class HomePage extends StatelessWidget {
}

Horizontal Rule

To create a horizontal rule, use either three asterisks (***), dashes (---), or underscores (___) with empty lines above and below for better compatibility

Looks like this:

---

Links

Web link

Markdown	HTML	Rendered Output
[GitHub Link](https://github.com/)	<a href="https://github.com/">GitHub Link</a>	GitHub Link

WikiLinks

To link to other files in your main folder, you can do [[file.md]] that will take you to said file, you can also use full [[/storage/emulated/Documents/Notes/file.md]] or relative path [[Notes/file.md]] as well, be it a markdown file, image, or pdf. You can also add custom names to it like this [[file.md|My Notes]] which will show up as My Notes.

Images

From Web

Markdown	HTML	Rendered Output
	<img src="https://live.staticflickr.com/689/20815840526_ce0c35ce7d_b.jpg" alt="Nature" />

Local

For local images that exist in the main folder used by app, you can use just the name of the file, full path, or relative path ex:

![](localImg.png)
or
![](/storage/1C10-3618/Documents/Notes/IMGs/localImg.png)
or
![](IMGs/localImg.png)

Tags

Tags will only work if they are first on a new line

You can remove the space between the pound sign (#) and the title, so instead of a header for a tag
Looks like this:
#Tag = #Tag

Note: the background color will match primary color of the theme you selected in app instead of yellow

Superscript and Subscript

To have characters appear higher (superscript) or lower (subscript), you can do it like this:

Markdown	Rendered Output
X^2^	X2
H~2~O	H2O

Escaping Syntax Characters

You can escape formatting syntax by using a backslash (\) like \` or \> or \#