Basic formatting syntax

Boardeaux combines a syntax for formatting text called Markdown, which supports HTML tags, along with a few unique writing features.

Markdown is a lightweight markup language that you can use to add formatting elements to plain text documents.

Headings

To create a heading, add number signs (#) in front of a word or phrase. The number of number signs you use should correspond to the heading level. Always put a space between the number signs and the heading name!

You can also use the <h1÷6> HTML tags.

# Heading level 1
## Heading level 2

Rendered Output:

Heading level 1

Heading level 2

Paragraphs

To create paragraphs, use a blank line to separate one or more lines of text.

Line Breaks

To create a line break:
* Include an HTML single line break tag <br> at the end of the first line, and then press Return.
* End a line with two or more spaces, and then press Return.
* Include a backslash \ at the end of the first line, and then press Return.

Styling text

You can indicate emphasis with bold, italics, or strikethrough.
* To bold text, add two asterisks (**) or underscores (__) without spaces around the word or phrase.
* To italicize text, add one asterisk (*) or underscore (_) without spaces around the word or phrase.
* To strike through text, add one or two tildes (~~) without spaces around the word or phrase.

Style Syntax Rendered Output Keyboard shortcut

Bold

**Bold** or __Bold __

Bold

Cmd+B (Mac) or Ctrl+B (Windows/Linux)

Italic

*Italic* or _Italic_

Italic

Cmd+I (Mac) or Ctrl+I (Windows/Linux)

Bold and Italic

***Bold & Italic*** or ___Bold & Italic___

Bold & Italic

None

Bold and nested italic

**bold _italic_ text**

bold italic text

None

Strikethrough

~~Strikethrough~~ or ~Strikethrough~

Strikethrough

None

Lists

You can organize items into ordered, unordered, nested, and task lists.

Ordered Lists

To create an ordered list, add line items with numbers followed by periods or parenthesis. The numbers don’t have to be in numerical order.

Always put a space between the periods or parenthesis and the following data!

Markdown Rendered Output

1. First item
2. Second item
3. Third item

1. First item
2. Second item
3. Third item

1. First item
1. Second item
1. Third item

1. First item
2. Second item
3. Third item

1. First item
8. Second item
3. Third item

1. First item
2. Second item
3. Third item

1. First item
2. Second item
    1. Indented item
    2. Indented item
3. Third item

  1. First item

  2. Second item

    1. Indented item

    2. Indented item

  3. Third item

1) First item
2) Second item
3) Third item

1. First item
2. Second item
3. Third item


Unordered Lists

To create an unordered list, add dashes (-), asterisks (*), or plus signs (+) in front of line items. Indent one or more items to create a nested list.

Always put a space between the unordered list symbols and the following data!

If you need to start an unordered list item with a number followed by a period, you can use a backslash (\) to escape the period.

Markdown Rendered Output

- First item
- Second item
- Third item

  • First item

  • Second item

  • Third item

* First item
* Second item
* Third item

  • First item

  • Second item

  • Third item

+ First item
+ Second item
+ Third item

  • First item

  • Second item

  • Third item

- First item
- Second item
    - Indented item
    - Indented item
- Third item

  • First item

  • Second item

    • Indented item

    • Indented item

  • Third item

- 1968\. List item with a number followed by a period
- Second item.

  • 1968. List item with a number followed by a period

  • Second item.


Nested Lists

You can create a nested list by indenting one or more list items below another item.

1. First list item
   - First nested list item
     - Second nested list item

Rendered Output:

  1. First list item

    • First nested list item

      • Second nested list item


Task lists

To create a task list, preface list items with a hyphen (-) and a space, followed by [ ].
To mark a task as complete, use [x].
Always put spaces around the square brackets!

- [x] Checked item
- [ ] Unchecked item

Rendered Output:

  • Checked item

  • Unchecked item

Code block & Code inline

To denote a word or phrase as code, enclose it in backticks (`).

To format code or text into its own distinct block, use triple backticks. The opening and closing triple backticks must be placed on separate lines!

Markdown Rendered Output

`Code inline`

Code inline

 
```
Code
block
```
 
Code
block

Links

  • To create a link, enclose the link text in brackets [] and then follow it immediately with the URL in parentheses ().

Keyboard shortcut: Cmd+K (Mac) or Ctrl+K (Windows/Linux)

Markdown Rendered Output

[Boardeaux](https://boardeaux.app)

Boardeaux

  • Links are automatically created when valid URLs are written:

https://boardeaux.app

  • To quickly turn a URL or email address into a link, enclose it in angle brackets:

Markdown Rendered Output

<https://boardeaux.app>

https://boardeaux.app

Images

To add an external image, add an exclamation mark !, followed by alt text in brackets [], and the path or URL to the image asset in parentheses ().

![Alt text](https://elsci.io/img/molbrett-artist.37c20fea.jpg)

Rendered Output:

Alt text

Horizontal Rules

To create a horizontal rule, use three or more asterisks (***), dashes (---), or underscores (___) on a line by themselves.