Markdown Styleguide

This document should serve as a guide for the Markdown format which is commonly used in Codeberg.

Bold

Use two stars at the beginning and the end of a section of text to highlight the section in bold.

Italics

Use one star at the beginning and the end of a section to highlight the section in italics.

Links

Use [link description](link) to link to another section, article or website.

To insert a link without a link description, surround the link by less-than < and greater-than > characters. This is preferred to just adding an url within the text as it is easier to parse the URLs.

Example:

https://codeberg.org/

Topics

Use ATX Style topics by adding one or more hash # signs to the start of the topic line.

Preformatted sections

Use a single backtick characters to preformat a word or a section within a line.

Use three backticks to begin and end a preformatted section.

Use rendering hints to tell the renderer whether to syntax highlight your section and which language should be used.

Tables

Always delimit both sides of a table with pipes |. Keep the tables readable even in the un-rendered text-form.

Contribuer

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.