Skip to content

Support us

Authors: fire1ce | Created: 2022-02-20 | Last update: 2022-04-03

Tables, Lists and Quotes

Tables

A table in Markdown consists of two parts: the header and the rows of data in the table. As per the Markdown spec:

  • pipe (|) character separates the individual columns in a table.
  • (-) hyphens act as a delimiter row to separate the header row from the body.
  • (:) colon to align cell contents.
Table Example
| **Option** | **Description**                            |
| ---------- | ------------------------------------------ |
| data       | path to data files to supply the data.     |
| engine     | engine to be used for processing templates |
| ext        | extension to be used for dest files.       |

Result:

Option Description
data path to data files to supply the data.
engine engine to be used for processing templates
ext extension to be used for dest files.

Column Alignment

If you want to align a specific column to the left, center or right, you can use the [regular Markdown syntax] placing : characters at the beginning and/or end of the divider.

Data table, columns aligned to left
| Method      | Description                          |
| :---------- | :----------------------------------- |
| `GET`       | :material-check:     Fetch resource  |
| `PUT`       | :material-check-all: Update resource |
| `DELETE`    | :material-close:     Delete resource |
Method Description
GET Fetch resource
PUT Update resource
DELETE Delete resource
Data table, columns centered
| Method      | Description                          |
| :---------: | :----------------------------------: |
| `GET`       | :material-check:     Fetch resource  |
| `PUT`       | :material-check-all: Update resource |
| `DELETE`    | :material-close:     Delete resource |
Method Description
GET Fetch resource
PUT Update resource
DELETE Delete resource
Data table, columns aligned to right
| Method      | Description                          |
| ----------: | -----------------------------------: |
| `GET`       | :material-check:     Fetch resource  |
| `PUT`       | :material-check-all: Update resource |
| `DELETE`    | :material-close:     Delete resource |
Method Description
GET Fetch resource
PUT Update resource
DELETE Delete resource

Lists

Unordered List

Bullet point lists can be created by starting each line with an asterisk followed by a space before the content of the bullet point. Note that the space is important and should not be forgotten.

Example:

Unordered List Example
- Lorem ipsum dolor sit amet
- Consectetur adipiscing elit
- Integer molestie lorem at massa
- Facilisis in pretium nisl aliquet

Result:

  • Lorem ipsum dolor sit amet
  • Consectetur adipiscing elit
  • Integer molestie lorem at massa
  • Facilisis in pretium nisl aliquet

Ordered List

Similarly, numbered lists can be created by starting each line with a number followed by a space and then the relevant text.

Ordered List Example
1. Lorem ipsum dolor sit amet
2. Consectetur adipiscing elit
3. Integer molestie lorem at massa
4. Faucibus porta lacus fringilla vel
5. Aenean sit amet erat nunc
6. Eget porttitor lorem

Result:

  1. Lorem ipsum dolor sit amet
  2. Consectetur adipiscing elit
  3. Integer molestie lorem at massa
  4. Faucibus porta lacus fringilla vel
  5. Aenean sit amet erat nunc
  6. Eget porttitor lorem

Blocks List

Blocks List Example
> - list under lists
> - under lists

Result:

  • list under lists
  • under lists

Tasklists

A task list is a set of tasks that each render on a separate line with a clickable checkbox. You can select or deselect the checkboxes to mark the tasks as complete or incomplete.

You can use Markdown to create a task list in any comment on GitHub. If you reference an issue, pull request, or discussion in a task list, the reference will unfurl to show the title and state.

Example:

Task List Example
- [x] Lorem ipsum dolor sit amet, consectetur adipiscing elit
- [ ] Vestibulum convallis sit amet nisi a tincidunt
  - [x] In hac habitasse platea dictumst
  - [x] In scelerisque nibh non dolor mollis congue sed et metus
  - [ ] Praesent sed risus massa
- [ ] Aenean pretium efficitur erat, donec pharetra, ligula non scelerisque

Result:

  • Lorem ipsum dolor sit amet, consectetur adipiscing elit
  • Vestibulum convallis sit amet nisi a tincidunt
  • In hac habitasse platea dictumst
  • In scelerisque nibh non dolor mollis congue sed et metus
  • Praesent sed risus massa
  • Aenean pretium efficitur erat, donec pharetra, ligula non scelerisque

Block Quotes

For quoting blocks of content from another source within your document.

Add > before any text you want to quote.

Quoting Blocks Example
> Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante.
> Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue.

Result:

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante. Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue.

Nested Block Quotes

Quoting Blocks Nested Example
> Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante.
> Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue.
>
> > Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctorodio
> > non est accumsan facilisis. Aliquam id turpis in dolor tincidunt mollis ac eu diam.

Result:

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante. Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue.

Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctorodio non est accumsan facilisis. Aliquam id turpis in dolor tincidunt mollis ac eu diam.