About Markdown

Markdown is a lightweight and easy-to-use text formatting syntax, which looks like plain text with a few non-alphabetic characters. AIstant article editor has a toolbar that allows you to add these characters automatically. You can preview all of your edits by using the preview_icon button in the editor.

Here is an overview of Markdown syntax:

Text

To format your texts in Markdown, enclose the text in double asterisks or double underscores for bold and in single asterisks or single underscores for italics.

**bold text**
*italic text*
__also bold text__
_also italic text_

bold text
italic text
also bold text
also italic text

To add links to your text, use the following syntax:

[AIstant](https://aistant.com/)

AIstant

To quote someone in a text, put the > character before the quote.

> This is a quote.

This is a quote.

Headers

To create headers in Markdown, precede the header text with the # character. The number of # characters should correspond with the header tag level. Please note that there should always be a space between the characters and the text. For example:

# This is an <h1> tag
## This is an <h2> tag
###### This is an <h6> tag

This is an <h1> tag

This is an <h2> tag

This is an <h6> tag

Lists

To create a numbered (ordered) list in Markdown, just start the list with 1., and the numbering will be continue automatically.

1. Numbered list line 1
2. Numbered list line 2
3. Numbered list line 3
  1. Numbered list line 1
  2. Numbered list line 2
  3. Numbered list line 3

To create a bulleted (unordered) list in Markdown, start each list line with an asterisk:

* Bulleted (unordered) list line 1
* Bulleted (unordered) list line 2
* Bulleted (unordered) list line 3
  • Bulleted (unordered) list line 1
  • Bulleted (unordered) list line 2
  • Bulleted (unordered) list line 3

Alternatively, you can use dashes.

- Bulleted (unordered) list line 1
- Bulleted (unordered) list line 2
- Bulleted (unordered) list line 3
  • Bulleted (unordered) list line 1
  • Bulleted (unordered) list line 2
  • Bulleted (unordered) list line 3

For nested lists, just put two spaces before the dash or asterisk:

- Bulleted (unordered) list line 1
- Bulleted (unordered) list line 2
  - Bulleted (unordered) list nested line 1
  - Bulleted (unordered) list nested line 2
- Bulleted (unordered) list line 3
  • Bulleted (unordered) list line 1
  • Bulleted (unordered) list line 2
    • Bulleted (unordered) list nested line 1
    • Bulleted (unordered) list nested line 2
  • Bulleted (unordered) list line 3

Images

Use the following syntaxt for images:

![AIstant logo](https://aistant.com/assets/img/logo.png)

AIstant logo

Code

To highlight code snippets in your articles, enclose the code in triple single quotes:

``` code ```

code

To refer to the code inline, enclose the code in single quotes:

I am quoting the `<h1>` tag.

I am quoting the <h1> tag.

To escape the Markdown syntax, for example, a # character, if you are not going to add a header, just place the back slash before this symbol.

\# is a Markdown character.

# is a Markdown character.

For more information regarding Markdown, see the Github guide and the Confluence guide