Documentation/content/markdown/using-lists.md
Javier Pérez e405ae93ae Lint the documentation (#626)
# Changelog

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).

## Removed

- Disable the Markdownlint rule MD024 (`Multiple headings with the same content`).

## Fixed

- Syntax errors in `.markdownlint.yaml`.
- Markdownlint issues:
  - Heading levels should only increment by one level at a time([MD001](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md001.md))
  - Hard tabs ([MD010](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md010.md))
  - Reversed link syntax ([MD011](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md011.md))
  - Dollar signs used before commands without showing output ([MD014](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md014.md))
  - Multiple top-level headings in the same document ([MD025](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md025.md))
  - Trailing punctuation in heading ([MD026](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md026.md))
  - Ordered list item prefix([MD029](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md029.md))
  - Emphasis used instead of a heading([MD036](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md036.md))
  - Fenced code blocks should have a language specified ([MD040](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md040.md))
  - Link fragments should be valid ([MD051](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md051.md))
  - Link text should be descriptive ([MD059](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md059.md))

- Prettier issues.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/626
Reviewed-by: Patrick Schratz <pat-s@noreply.codeberg.org>
Co-authored-by: Javier Pérez <walpo@noreply.codeberg.org>
Co-committed-by: Javier Pérez <walpo@noreply.codeberg.org>
2025-06-14 15:39:01 +02:00

1.1 KiB

eleventyNavigation
key title parent order
UsingLists Using Lists Markdown 60

You can use lists in your Markdown files.

Unordered lists

To use an unordered list (bullet points), simply begin your list items with a dash - or a star *.

For example:

- This
- is
- a
- simple
- bullet
- point
- list

This gets rendered as:

  • This
  • is
  • a
  • simple
  • bullet
  • point
  • list

Numbered lists

To use a numbered list, simply begin your list items with a number.

1. This
2. is
3. a
4. numbered
5. list

Gets rendered as:

  1. This
  2. is
  3. a
  4. numbered
  5. list

Note that the numbers do not have to be in the correct order (even though it is easier to read in the non-rendered form):

1. This
1. is
1. also
1. a
1. numbered
1. list

will also render to a correctly numbered list:

  1. This
  2. is
  3. also
  4. a
  5. numbered
  6. list

Some editors even autocorrect this to a correctly numbered list. (If the example above does no longer start with 1. on each line, please feel free to reintroduce the mistake for illustration purposes.)