dallasgroot/Documentation
1
0
Fork 0
mirror of https://codeberg.org/Codeberg/Documentation.git synced 2026-06-16 05:13:54 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions
Documentation/content/markdown/topics.md
crapStone da1b77aa6a Add woodpecker ci & many linters (and their required fixes) (#377) 
closes #238

Co-authored-by: pat-s <patrick.schratz@gmail.com>
Co-authored-by: Patrick Schratz <pat-s@noreply.codeberg.org>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/377
Co-authored-by: crapStone <crapstone01@gmail.com>
Co-committed-by: crapStone <crapstone01@gmail.com>
2024-06-11 07:51:22 +00:00

1.3 KiB
Raw Blame History

eleventyNavigation
key title parent order
Topics Topics Markdown 40

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

1st Topic

## 2nd Topic

2nd Topic

### 3rd Topic

3rd Topic

Examples of topics with dashes and equal signs

This is a topic
===============

This is a topic

This is another topic
---------------------

This is another topic