08 Block quotes, lists and alerts

8Block quotes, lists and alerts

Markdown can produce its own numbered and unnumbered lists, these can be mixed and nested as required. These lists are quite basic and don’t look very good (lists within the PracticalSeries Wikis use tables to give better structure and formatting, see section 10 for details).

Block quotes and alerts are used to highlight particular text.

⬆️ Top

8.1Block quotes

Block quotations are areas of text that are highlighted to make them distinct from the normal body text, they look like this:

This is an extract from “Race to the Moon”: Cox, Catherine Bly & Charles Murray (1989). Published by Simon and Schuster. There is a Kindle version by the same authors, but it is just called Apollo.

Block quotations are so called because they often contain quotes or references to other works. In practice, block quotations can be used for any purpose.

GitHub displays block quotations with a 4 px wide grey bar on the left-hand side of the text area. The text is indented by 4.5 spaces and is in a grey colour: #59636E or rgb(89,99,110) that is lighter than the body text colour. Block quotation text is the same point size as body text.

Block quotations are created in Markdown by starting the line with a single greater than sign > followed by a space:

^{Markdown, HTML equivalence and GitHub output}
${\large \color{#0050C0}\text{M\ A\ R\ K\ D\ O\ W\ N}}$ 🔽	${\large \color{#00C050}\text{H\ T\ M\ L}}$ 🔽	${\large \color{#B00000}\text{G\ I\ T\ H\ U\ B}\space\ \space\text{O\ U\ T\ P\ U\ T}}$ 🔽
> First line > > Second line	<blockquote> <p>First line</p> <p>Second line</p> </blockquote>	First line Second line
^{Table 8.1 — Block quotes}

A blank line with a leading greater than > can be used to separate paragraphs in a block quotation.

⬆️ Top

8.1.1Nested block quotes

Block quotes can be nested by adding extra > at the start of the text:

^{Markdown, HTML equivalence and GitHub output}
${\large \color{#0050C0}\text{M\ A\ R\ K\ D\ O\ W\ N}}$ 🔽	${\large \color{#00C050}\text{H\ T\ M\ L}}$ 🔽	${\large \color{#B00000}\text{G\ I\ T\ H\ U\ B}\space\ \space\text{O\ U\ T\ P\ U\ T}}$ 🔽
> First level > >> Second level >> >>> Third level >>> >>>> Fourth level >>> >>> Third level >> >> Second level > > First level	<blockquote> <p>First level</p> <blockquote> <p>Second level</p> <blockquote> <p>Third level</p> <blockquote> <p>Fourth level</p> </blockquote> <p>Third level</p> </blockquote> <p>Second level</p> </blockquote> <p>first level</p> </blockquote>	First level Second level Third level Fourth level Third level Second level first level
^{Table 8.2 — Nested block quotes}

⬆️ Top

8.1.2Other elements inside block quotes

Block quotes can contain other Markdown elements such as headings, emphasis (bold, italic, underline &c.), they can also contain lists (GitHub supports lists in block quotes). The lists can be ordered or unordered (see section 8.3 and section 8.2). The following shows some examples:

^{Markdown, HTML equivalence and GitHub output}
${\large \color{#0050C0}\text{M\ A\ R\ K\ D\ O\ W\ N}}$ 🔽	${\large \color{#00C050}\text{H\ T\ M\ L}}$ 🔽	${\large \color{#B00000}\text{G\ I\ T\ H\ U\ B}\space\ \space\text{O\ U\ T\ P\ U\ T}}$ 🔽
> # Block Quotes > > With lists > > * List point 1 > * List point 2 > > Last line**	<blockquote> <h1> Block Quotes </h1> <p> With lists</p> <ul> <li> List point 1</li> <li> List point 2</li> </ul> <p><em>Last <strong>line</strong></em></p> </blockquote>	Block Quotes With lists List point 1 List point 2 Last line
^{Table 8.3 — Markdown elements in block code}

⬆️ Top

8.1.3Markdown rules for block quotes

	^{List 8.1 — Markdown rules for block quotes}
❶	Always leave a blank line before and after block quotes
❷	Separate paragraphs with a `>` on a blank line
❸	Block quotes can be nested without limit
❹	Block quotes are the same point size as body text

⬆️ Top

8.2Unordered (unnumbered) lists

Unordered or unnumbered lists are the simplest form of list, they appear as indented lines with a point (•) at the start of the line:

First point
Second point
Third point

Unordered lists are created in Markdown by starting the line with a single asterisk * followed by a space, a single dash - followed by a space or a single plus + followed by a space.

The following all work:

^{Markdown, HTML equivalence and GitHub output}
${\large \color{#0050C0}\text{M\ A\ R\ K\ D\ O\ W\ N}}$ 🔽	${\large \color{#00C050}\text{H\ T\ M\ L}}$ 🔽	${\large \color{#B00000}\text{G\ I\ T\ H\ U\ B}\space\ \space\text{O\ U\ T\ P\ U\ T}}$ 🔽
* First point * Second point * Third point Or - First point - Second point - Third point Or + First point + Second point + Third point	<ul> <li>First point</li> <li>Second point</li> <li>Third point</li> </ul>	First point Second point Third point
^{Table 8.4 — Unordered list}

Tip

Don’t mix and match the delimiters *, +, or -; if you do, GitHub will interpret it as the start of a new list and will change the line spacing, pick one and stick to it throughout the list.

Whichever delimiter you use, it must be the first character on the line (spaces in front of it will be ignored), any non-space character that precedes it will cause the line to render as normal text.

⬆️ Top

8.2.1Nested unordered lists

It is possible to nest unordered lists:

Level 1 point 1
Level 1 point 2
- Level 2 point 1
- Level 2 point 2
  - Level 3 point 1
Level 1 point 3
Level 1 point 4

Unordered lists are nested by indenting each list by at least two spaces (four is more conventional) before the delimiter for each additional level. The above is generated as follows:

^{Markdown, HTML equivalence and GitHub output}
${\large \color{#0050C0}\text{M\ A\ R\ K\ D\ O\ W\ N}}$ 🔽	${\large \color{#00C050}\text{H\ T\ M\ L}}$ 🔽	${\large \color{#B00000}\text{G\ I\ T\ H\ U\ B}\space\ \space\text{O\ U\ T\ P\ U\ T}}$ 🔽
* Level 1 point 1 * Level 1 point 2 * Level 2 point 1 * Level 2 point 2 * Level 3 point 1 * Level 1 point 3 * Level 1 point 4	<ul> <li>Level 1 point 1</li> <li>Level 1 point 2</li> <ul> <li>Level 2 point 1</li> <li>Level 2 point 2</li> <ul> <li>Level 3 point 1</li> </ul> </ul> <li>Level 1 point 3</li> <li>Level 1 point 4</li> </ul>	Level 1 point 1 Level 1 point 2 Level 2 point 1 Level 2 point 2 Level 3 point 1 Level 1 point 3 Level 1 point 4
^{Table 8.5 — Nested unordered list}

Nesting uses different bullet marks for the first three levels: black circle: ${\color{#000000}\text{⏺}}$, open circle: ${\color{#000000}\text{⭘}}$ and black square: ${\color{#000000}\text{⯀}}$. All subsequent nesting levels just use the black square:

Level 1
- Level 2
  - Level 3
    - Level 4
      - Level 5

Unordered lists can be indented as far as you like.

⬆️ Top

8.2.2Type of bullet point

The type of bullet point used is fixed in Markdown: a black circle for the first level, open circle for the second and black square for all other layers.

HTML allows the type of bullet point to be selected (within limits) with the use of the type attribute. The type attribute can specify a disk, a circle, a square, or none.

^{HTML and GitHub output}
${\large \color{#00C050}\text{H\ T\ M\ L}}$ 🔽	${\large \color{#B00000}\text{G\ I\ T\ H\ U\ B}\space\ \space\text{O\ U\ T\ P\ U\ T}}$ 🔽
<ul type = "disk"> <li>First point</li> <li>Second point</li> <li>Third point</li> </ul>	First point Second point Third point
<ul type = "circle"> <li>First point</li> <li>Second point</li> <li>Third point</li> </ul>	First point Second point Third point
<ul type = "square"> <li>First point</li> <li>Second point</li> <li>Third point</li> </ul>	First point Second point Third point
<ul type = "none"> <li>First point</li> <li>Second point</li> <li>Third point</li> </ul>	First point Second point Third point
^{Table 8.6 — HTML bullet types}

⬆️ Top

8.2.3Indents and spacing

In terms of spacing, the point mark (•) is indented three spaces from the left edge of the text area, the text following the point mark is indented a further two spaces.

If the line of text following the point wraps at the end of a line, the text will maintain the correct indentation as follows:

Point 1
Lorem ipsum dolor sit amet, consectetur adipiscing elit. In consectetur tortor a tortor ornare, non pretium diam faucibus. Morbi ut mollis dolor, nec pretium tellus. Suspendisse ornare neque placerat orci aliquam, eu sodales dui blandit. Maecenas nec risus vel magna blandit euismod. Suspendisse id finibus purus. Nam ultricies non sapien ac rutrum.
Point 3

Here the second point wraps at the end of the line, but maintains the correct indentation.

Each nested level indents the list by a further seven spaces before the bullet point, the text following the bullet point is always indented two spaces.

⬆️ Top

8.2.4Numbers in an unordered list

A slightly misleading heading.

If you start an unordered list with a number let’s say:

^{Markdown and GitHub output}
${\large \color{#0050C0}\text{M\ A\ R\ K\ D\ O\ W\ N}}$ 🔽	${\large \color{#B00000}\text{G\ I\ T\ H\ U\ B}\space\ \space\text{O\ U\ T\ P\ U\ T}}$ 🔽
* 2004, Markdown invented * 2008, GitHub adds Wiki support	2004, Markdown invented 2008, GitHub adds Wiki support
^{Table 8.7 — Numbers at the start of an unordered list}

Then everything is fine, the list displays as you would expect: bullet point followed by the text.

If however, the number was followed by a full stop:

^{Markdown and GitHub output}
${\large \color{#0050C0}\text{M\ A\ R\ K\ D\ O\ W\ N}}$ 🔽	${\large \color{#B00000}\text{G\ I\ T\ H\ U\ B}\space\ \space\text{O\ U\ T\ P\ U\ T}}$ 🔽
* 2004. Markdown invented * 2008. GitHub adds Wiki support	Markdown invented GitHub adds Wiki support
^{Table 8.8 — Numbers with a full stop at the start of an unordered list}

It converts the list to an ordered list (numbers followed by a full stop are interpreted as an ordered list, see section 8.3) and displays the number in roman numerals (again see section 8.3 for details). This is GitHub trying to make sense of the conflicting information we have supplied it.

It’s the full stop after the number that cause the problem, GitHub thinks were trying to create an ordered list starting at 2004, it displays it as roman numerals because it is preceded by an asterisk (see section 8.3.3 for details).

To make the list display properly, we need to escape the full stop (see Table 7.1) by putting a backslash in front of it:

^{Markdown and GitHub output}
${\large \color{#0050C0}\text{M\ A\ R\ K\ D\ O\ W\ N}}$ 🔽	${\large \color{#B00000}\text{G\ I\ T\ H\ U\ B}\space\ \space\text{O\ U\ T\ P\ U\ T}}$ 🔽
* 2004\. Markdown invented * 2008\. GitHub adds Wiki support	2004. Markdown invented 2008. GitHub adds Wiki support
^{Table 8.9 — Numbers with an escaped full stop at the start of an unordered list}

⬆️ Top

8.2.5Adding paragraphs to an unordered list

It is possible to add an additional paragraph to an unordered list by indenting it by at least two spaces:

^{Markdown, HTML equivalence and GitHub output}
${\large \color{#0050C0}\text{M\ A\ R\ K\ D\ O\ W\ N}}$ 🔽	${\large \color{#00C050}\text{H\ T\ M\ L}}$ 🔽	${\large \color{#B00000}\text{G\ I\ T\ H\ U\ B}\space\ \space\text{O\ U\ T\ P\ U\ T}}$ 🔽
* First point Additional paragraph * Second point * Third point	<ul> <li>First point</li> <p>Additional paragraph</p> <li>Second point</li> <li>Third point</li> </ul>	First point Additional paragraph Second point Third point
^{Table 8.10 — Unordered list with an additional paragraph}

The additional paragraph must have a blank line before and after.

⬆️ Top

8.2.6Other elements inside an unordered list

Unordered lists can contain other Markdown elements such as headings, emphasis (bold, italic, underline &c.) and block quotes. The following shows some examples:

^{Markdown, HTML equivalence and GitHub output}
${\large \color{#0050C0}\text{M\ A\ R\ K\ D\ O\ W\ N}}$ 🔽	${\large \color{#00C050}\text{H\ T\ M\ L}}$ 🔽	${\large \color{#B00000}\text{G\ I\ T\ H\ U\ B}\space\ \space\text{O\ U\ T\ P\ U\ T}}$ 🔽
* ### First point > Block quote * Second point * Third point	<ul> <li><h3>First point</h3></li> <blockquote> Block quote </blockquote> <li><em>Second point</em></li> <li>Third point</li> </ul>	First point Block quote Second point Third point
^{Table 8.11 — Unordered list with additional elements}

⬆️ Top

8.2.7Markdown rules for unordered lists

	^{List 8.2 — Markdown rules for unordered lists}
❶	Always use the same delimiter in an unordered list, don’t mix the `*`, `-` or `+` in the same list.
❷	If starting with a number followed by a full stop, escape the full stop by using `\.`
❸	Nest lists by indenting the levels by at least two additional spaces before the delimiter

⬆️ Top

8.3Ordered (numbered) lists

Ordered or numbered lists are lists that are automatically numbered when rendered by GitHub. They consist of a number followed by a full stop. The number increments for each new line in the list:

Point 1
Point 2
Point 3

Ordered lists are created in Markdown by entering a number followed by a full stop 1. and a space.

Only the first number (top line of the list) matters, this will be the starting number of the list.

The following all work:

^{Markdown, HTML equivalence and GitHub output}
${\large \color{#0050C0}\text{M\ A\ R\ K\ D\ O\ W\ N}}$ 🔽	${\large \color{#00C050}\text{H\ T\ M\ L}}$ 🔽	${\large \color{#B00000}\text{G\ I\ T\ H\ U\ B}\space\ \space\text{O\ U\ T\ P\ U\ T}}$ 🔽
1. First point 2. Second point 3. Third point Or 1. First point 1. Second point 1. Third point Or 1. First point 4. Second point 6. Third point Or 1. First point 10. Second point 3. Third point	<ol> <li>First point</li> <li>Second point</li> <li>Third point</li> </ol>	First point Second point Third point
^{Table 8.12 — Ordered list}

In the above table, all the Markdown options produce the same result (a list numbered 1, 2 and 3), this is because the first number in each list is the number 1. The numbers for each subsequent point in a list are calculated automatically by GitHub when it renders the page, the actual numbers in the Markdown text are ignored.

Whichever number you use, it must be the first character on the line (spaces in front of it will be ignored), any non-space character that precedes it will cause the line to render as normal text.

⬆️ Top

8.3.1Starting at a different number

^{Markdown, HTML equivalence and GitHub output}
${\large \color{#0050C0}\text{M\ A\ R\ K\ D\ O\ W\ N}}$ 🔽	${\large \color{#00C050}\text{H\ T\ M\ L}}$ 🔽	${\large \color{#B00000}\text{G\ I\ T\ H\ U\ B}\space\ \space\text{O\ U\ T\ P\ U\ T}}$ 🔽
7. First point 8. Second point 9. Third point Or 7. First point 1. Second point 1. Third point Or 7. First point 4. Second point 6. Third point Or 7. First point 10. Second point 3. Third point	<ol start="7"> <li>First point</li> <li>Second point</li> <li>Third point</li> </ol>	First point Second point Third point
^{Table 8.13 — Ordered list starting at a specific number}

Note

It is not possible to skip numbers in an ordered list.

⬆️ Top

8.3.2Nested ordered lists

It is possible to nest ordered lists:

Level 1 point 1
Level 1 point 2 *. Level 2 point 1
1. Level 2 point 2
  1. Level 3 point 1
Level 1 point 3 1 Level 1 point 4

Ordered lists are nested by indenting each list by four spaces before the number for each additional level. The above is generated as follows:

^{Markdown, HTML equivalence and GitHub output}
${\large \color{#0050C0}\text{M\ A\ R\ K\ D\ O\ W\ N}}$ 🔽	${\large \color{#00C050}\text{H\ T\ M\ L}}$ 🔽	${\large \color{#B00000}\text{G\ I\ T\ H\ U\ B}\space\ \space\text{O\ U\ T\ P\ U\ T}}$ 🔽
1. Level 1 point 1 1. Level 1 point 2 1.. Level 2 point 1 1. Level 2 point 2 1. Level 3 point 1 1. Level 1 point 3 1 Level 1 point 4	<ol> <li>Level 1 point 1</li> <li>Level 1 point 2</li> <ol> <li>Level 2 point 1</li> <li>Level 2 point 2</li> <ol> <li>Level 3 point 1</li> </ol> </ol> <li>Level 1 point 3</li> <li>Level 1 point 4</li> </ol>	Level 1 point 1 Level 1 point 2 Level 2 point 1 Level 2 point 2 Level 3 point 1 Level 1 point 3 Level 1 point 4
^{Table 8.14 — Nested ordered list}

Nesting uses different numbering mechanisms for the first three levels: Arabic numerals (1, 2, 3…), lower case Roaman numerals (i, ii, iii…) and lowercase letters (a, b, c…). All subsequent nesting levels use the lowercase letters.

Level 1
1. Level 2
  1. Level 3
    1. Level 4
      1. Level 5

Ordered lists can be indented as far as you like.

⬆️ Top

8.3.3Type of numbering

The type of numbering used in ordered lists is fixed in Markdown: Arabic numerals (1, 2, 3…), lower case Roaman numerals (i, ii, iii…) and lowercase letters (a, b, c…) for all other layers.

HTML allows the type of numbering to be selected (within limits) with the use of the type attribute. The type attribute can specify Arabic numerals type = "1", lowercase alphabetically ordered type = "a", uppercase alphabetically ordered type = "A", lowercase Roman numerals type = "i" or uppercase Roman numerals type = "I".

^{HTML and GitHub output}
${\large \color{#00C050}\text{H\ T\ M\ L}}$ 🔽	${\large \color{#B00000}\text{G\ I\ T\ H\ U\ B}\space\ \space\text{O\ U\ T\ P\ U\ T}}$ 🔽
<ol type = "1"> <li>First point</li> <li>Second point</li> <li>Third point</li> </ol>	First point Second point Third point
<ol type = "a"> <li>First point</li> <li>Second point</li> <li>Third point</li> </ol>	First point Second point Third point
<ol type = "A"> <li>First point</li> <li>Second point</li> <li>Third point</li> </ol>	First point Second point Third point
<ol type = "i"> <li>First point</li> <li>Second point</li> <li>Third point</li> </ol>	First point Second point Third point
<ol type = "I"> <li>First point</li> <li>Second point</li> <li>Third point</li> </ol>	First point Second point Third point
^{Table 8.15 — HTML ordered list numeral types}

Tip

There is no none option for the type attribute when used with ordered lists (unlike the unordered list, see section 8.2.2).

⬆️ Top

8.3.4Indents and spacing

In terms of spacing, the number mark is indented two normal spaces and a thin space (see section 7.2) from the left edge of the text area^💠1, the text following the point mark is indented a further single space.

With nested levels, the text of each nested level is indented a further seven normal spaces.

If the line of text following the point wraps at the end of a line, the text will maintain the correct indentation as follows:

Point 1
Lorem ipsum dolor sit amet, consectetur adipiscing elit. In consectetur tortor a tortor ornare, non pretium diam faucibus. Morbi ut mollis dolor, nec pretium tellus. Suspendisse ornare neque placerat orci aliquam, eu sodales dui blandit. Maecenas nec risus vel magna blandit euismod. Suspendisse id finibus purus. Nam ultricies non sapien ac rutrum.
Point 3

Here the second point wraps at the end of the line, but maintains the correct indentation.

The full stop following the number is always in the same position from the left-hand edge of the screen.

As more digits are added (going from point 9 to point 10 or from point 99 to point 100 &c.) the left indentation becomes less. This can be seen in the following lists:

^{Figure 8.1 — Ordered list indentations}

In the above diagram the blue dashes show the position of the full stop following the number (these always line up), the black squares start at the left edge of the page (where the body text starts), the orange line shows the left edge of the body text area.

It can be seen that one and two-digit numbers are indented from the left-hand side of the text area, three-digit numbers start at exactly the edge of the text area and any number with more than three digit expands beyond the left edge of the text area (into the margin area).

⬆️ Top

8.3.5Adding paragraphs to an ordered list

It is possible to add an additional paragraph to an ordered list by indenting it four spaces:

^{Markdown, HTML equivalence and GitHub output}
${\large \color{#0050C0}\text{M\ A\ R\ K\ D\ O\ W\ N}}$ 🔽	${\large \color{#00C050}\text{H\ T\ M\ L}}$ 🔽	${\large \color{#B00000}\text{G\ I\ T\ H\ U\ B}\space\ \space\text{O\ U\ T\ P\ U\ T}}$ 🔽
1. First point Additional paragraph 1. Second point 1. Third point	<ol> <li>First point</li> <p>Additional paragraph</p> <li>Second point</li> <li>Third point</li> </ol>	First point Additional paragraph Second point Third point
^{Table 8.16 — Ordered list with an additional paragraph}

The additional paragraph must have a blank line before and after.

⬆️ Top

8.3.6Other elements inside an ordered list

Ordered lists can contain other Markdown elements such as headings, emphasis (bold, italic, underline &c.) and block quotes. The following shows some examples:

^{Markdown, HTML equivalence and GitHub output}
${\large \color{#0050C0}\text{M\ A\ R\ K\ D\ O\ W\ N}}$ 🔽	${\large \color{#00C050}\text{H\ T\ M\ L}}$ 🔽	${\large \color{#B00000}\text{G\ I\ T\ H\ U\ B}\space\ \space\text{O\ U\ T\ P\ U\ T}}$ 🔽
1. ### First point > Block quote 1. Second point 1. Third point	<ol> <li><h3>First point</h3></li> <blockquote> Block quote </blockquote> <li><em>Second point</em></li> <li>Third point</li> </ol>	First point Block quote Second point Third point
^{Table 8.17 — Ordered list with additional elements}

⬆️ Top

8.3.7Markdown rules for ordered lists

	^{List 8.2 — Markdown rules for unordered lists}
❶	The first number on the first line of a list is the starting number for the list
❷	Nest lists by indenting the levels by four spaces before the number
❸	Lists are always Arabic numerals (1, 2, 3…), nested lists use lowercase Roman numerals (i, ii, iii…) followed by lowercase letters for all other nesting levels (a, b, c…).

⬆️ Top

8.4Mixing ordered and unordered lists

It is possible to nest together ordered and unordered lists. This usually involves having an unordered list within an ordered list:

^{Markdown, HTML equivalence and GitHub output}
${\large \color{#0050C0}\text{M\ A\ R\ K\ D\ O\ W\ N}}$ 🔽	${\large \color{#00C050}\text{H\ T\ M\ L}}$ 🔽	${\large \color{#B00000}\text{G\ I\ T\ H\ U\ B}\space\ \space\text{O\ U\ T\ P\ U\ T}}$ 🔽
1. General Points * Max page length * Comments * Keyboard shortcuts 1. Wiki structures * Folder structures * Conventions 1. Managing a Wiki * Revision control * Managing commits	<ol> <li>General Points</li> <ul> <li>Max page length</li> <li>Keyboard shortcuts</li> </ul> <li>Wiki structures</li> <ul> <li>Folder structures</li> <li>Conventions</li> </ul> <li>Managing a Wiki</li> <ul> <li>Revision control</li> <li>Managing commits</li> </ul> </ol>	General Points Max page length Keyboard shortcuts Wiki structures Folder structures Conventions Managing a Wiki Revision control Managing commits
^{Table 8.18 — Ordered list with nested unordered lists}

They can also be the other way round (unordered list with nested ordered list):

^{Markdown, HTML equivalence and GitHub output}
${\large \color{#0050C0}\text{M\ A\ R\ K\ D\ O\ W\ N}}$ 🔽	${\large \color{#00C050}\text{H\ T\ M\ L}}$ 🔽	${\large \color{#B00000}\text{G\ I\ T\ H\ U\ B}\space\ \space\text{O\ U\ T\ P\ U\ T}}$ 🔽
* General Points 1. Max page length 1. Comments 1. Keyboard shortcuts * Wiki structures 1. Folder structures 1. Conventions * Managing a Wiki 1. Revision control 1. Managing commits	<ul> <li> General Points </li> <ol> <li>Max page length</li> <li>Keyboard shortcuts</li> </ol> <li>Wiki structures </li> <ol> <li>Folder structures</li> <li>Conventions</li> </ol> <li>Managing a Wiki</li> <ol> <li>Revision control</li> <li>Managing commits</li> </ol> </ul>	General Points Max page length Keyboard shortcuts Wiki structures Folder structures Conventions Managing a Wiki Revision control Managing commits
^{Table 8.19 — Unordered list with nested ordered lists}

Note

In both cases, the nested list start with the numerical arrangement or point style for that level of indentation (circles for the unordered list in the first example, Roman numerals for the ordered list in the second example).

⬆️ Top

8.5Task lists (check boxes)

Task lists are a special form of list with checkboxes:

General Points
Wiki structures
Managing a Wik

Task lists are created in Markdown by starting the line with a single dash - followed by a space, followed by an open bracket [ followed by a space followed by a close bracket ] followed by a space: - [ ] .

If the checkbox is to be shown ticked, put an x between the brackets (the x can be lower or uppercase).

The above image is generated with the following Markdown:

^{Markdown and GitHub output}
${\large \color{#0050C0}\text{M\ A\ R\ K\ D\ O\ W\ N}}$ 🔽	${\large \color{#B00000}\text{G\ I\ T\ H\ U\ B}\space\ \space\text{O\ U\ T\ P\ U\ T}}$ 🔽
- [ ] General Points - [x] Wiki structures - [X] Managing a Wik	General Points Wiki structures Managing a Wik
^{Table 8.20 — Task list Markdown}

Note

There is no HTML equivalent for task lists..

⬆️ Top

8.5.1Nested task lists

It is possible to nest task lists:

Task lists are nested by indenting each list by four spaces before the delimiter for each additional level. The above is generated as follows:

^{Markdown and GitHub output}
${\large \color{#0050C0}\text{M\ A\ R\ K\ D\ O\ W\ N}}$ 🔽	${\large \color{#B00000}\text{G\ I\ T\ H\ U\ B}\space\ \space\text{O\ U\ T\ P\ U\ T}}$ 🔽
- [ ] General Points - [ ] Max page length - [x] Comments - [x] Keyboard shortcuts - [ ] Wiki structures - [ ] Sidebars and Footnotes - [x] Folder structures - [ ] Conventions - [ ] PracticalSeries - [x] Standard - [x] Managing a Wiki - [x] Revision control - [x] Managing commits	General Points Max page length Comments Keyboard shortcuts Wiki structures Sidebars and Footnotes Folder structures Conventions PracticalSeries Standard Managing a Wiki Revision control Managing commits
^{Table 8.21 — Nested task lists}

Task lists can be indented as far as you like.

⬆️ Top

8.6Alerts

Alerts are similar to block quotes (see section 8.1) and are used to highlight specific information. GitHub supports five different types of alert:

Note

Sidenotes and footnotes for reference

Tip

Advice or guidance for doing something

Important

Essential information

Warning

Information for avoiding problems

Caution

Potential risks associated with specific actions

Alerts show a different coloured icon for each type and a similarly coloured 4 px wide bar at the left-hand edge of the text.

There is no HTML equivalent for alerts.

The Markdown for the above is:

^{Markdown and GitHub output}

${\large \color{#0050C0}\text{M\ A\ R\ K\ D\ O\ W\ N}}$ 🔽

> [!NOTE]
> Sidenotes and footnotes for reference

> [!TIP]
> Advice or guidance for doing something

> [!IMPORTANT]
> Essential information

> [!WARNING]
> Information for avoiding problems

> [!CAUTION]
> Potential risks associated with specific actions

^{Table 8.22 — Alert Markdown}

Note

Alerts cannot be used inside any form of HTML tag <p>, <table> &c.

The Markdown is fairly self-explanatory and is very similar to block quotes.

Alerts begin with a greater than sign followed by a space, an open bracket and an exclamation mark > [!.

It then has one of five words (in either upper or lowercase, it doesn’t matter): NOTE, TIP, IMPORTANT, WARNING or CAUTION (any other word will render the line as a block quote). This is followed by a closing bracket ]. There must be no further text on this line.

Subsequent lines in the alert begin with a greater than sign followed by a space > . If a blank line is needed in the alert, simply start it with a greater than sign > and leave the rest of the line blank.

Alerts use the following colours:

Alert	Colour
${\large \color{#0969DA}\text{Note}}$	`rgb(009, 105, 218)` or `#0969DA`
${\large \color{#1A7F37}\text{Tip}}$	`rgb(026, 127, 055)` or `#1A7F37`
${\large \color{#8250DF}\text{Important}}$	`rgb(130, 080, 223)` or `#8250DF`
${\large \color{#9A6700}\text{Warning}}$	`rgb(154, 103, 000)` or `#9A6700`
${\large \color{#CF222E}\text{Caution}}$	`rgb(207, 034, 046)` or `#CF222E`
^{Table 8.23 — Alert colours}

Note

Alerts cannot be nested.

⬆️ Top

8.6.1Markdown rules for alerts

	^{List 8.6 — Markdown rules for alerts}
❶	Always leave a blank line before and after alerts
❷	Alerts always have a header line: `[!type]`, where type is: `NOTE`, `TIP`, `IMPORTANT`, `WARNING` or `CAUTION`
❸	Each line of text in an alert starts with `>` followed by a space
❹	Separate paragraphs with a `>` on a blank line
❺	Alerts cannot be nested
❻	Alerts are the same point size as body text

Footnotes:

Note

^💠1 For the unordered list, the bullet point was indented three spaces, the thin space instead of the last space in the ordered list allows for the additional full stop character (leaving the actual text for the list indented to the same point as for an unordered list, everything lines up).↩