mirror of
https://codeberg.org/Codeberg/Documentation.git
synced 2026-06-19 06:43:53 -07:00
5f022adfc6
Add initial version of a Markdown documentation to explain Markdown to new contributors. Also provides a styleguide to guide to a consistent use of the Markdown markup within Codeberg. Fixes #59 Co-authored-by: Jan Klippel <c0d3b3rg@kl1pp3l.de> Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/221 Co-authored-by: jklippel <jklippel@noreply.codeberg.org> Co-committed-by: jklippel <jklippel@noreply.codeberg.org>
1.1 KiB
1.1 KiB
| eleventyNavigation | ||||||||
|---|---|---|---|---|---|---|---|---|
|
You can use lists in your markdown article.
Unnumbered lists
To use an unnumbered list (bullet point list), simple begin your list items with a dash - or a star *.
For example:
- This
- is
- a
- simple
- bullet
- point
- list
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. point
6. list
Gets rendered as:
- This
- is
- a
- numbered
- point
- list
Note that the numbers do not have to be counted up (even though it is easier to read in the non-renderd form):
1. This
1. is
1. also
1. a
1. numbered
1. point
1. list
will also render to a correctly numbered list:
- This
- is
- also
- a
- numbered
- point
- list
Some editors even autocorrect this to a correctly numbered list. (So if the example above does no longer start with 1.
on each line, please feel free to reintroduce the mistake for illustration purposes.)