mirror of
https://codeberg.org/Codeberg/Documentation.git
synced 2026-06-16 05:13:54 -07:00
941914f698
# Changelog The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/). ## Fixed - Lint issues: - Line length ([MD013](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md013.md)). - Heading levels should only increment by one level at a time ([MD001](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md001.md)). - Link fragments should be valid ([MD051](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md051.md)). --- Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/629 Reviewed-by: Gusted <gusted@noreply.codeberg.org> Co-authored-by: Javier Pérez <walpo@noreply.codeberg.org> Co-committed-by: Javier Pérez <walpo@noreply.codeberg.org>
1.2 KiB
1.2 KiB
| eleventyNavigation | ||||||||
|---|---|---|---|---|---|---|---|---|
|
Markdown can help you to divide a document into several parts using topics (a.k.a headings).
Topics can be specified in two ways:
- with one or more leading hash characters
#(ATX-Style) - by underlining a topic with dashes
-or equal signs=(Setext-Style)
The Setext provides only two layers of subdivision and the ATX-Style provides up to 6.
The Codeberg documentation uses the ATX-style. In the documentation, the first topic is omitted as it is already provided in the header section of the documentation file. See the article on How do I create a new article? for further details.
Note: This document may seem a little unstructured, as there are a bunch of topics with only a small amount of text. Unfortunately, there is no other way to present Topics in Markdown.
Examples of topics with hash characters
# 1st Topic
## 2nd Topic
### 3rd Topic
Examples of topics with dashes and equal signs
This is a topic
===============
This is another topic
---------------------