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

Hey there! 👋 Thank you for reading this article!

Is there something missing, or do you have an idea on how to improve the documentation? Do you want to write your own article?

You're invited to contribute to the Codeberg Documentation at its source code repository, for example, by adding a pull request or joining in on the discussion in the issue tracker.

For an introduction on contributing to Codeberg Documentation, please have a look at the Contributor FAQ.

© Codeberg Docs Contributors. See LICENSE