h759bkyo4/Documentation
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
Documentation/content/markdown/faq.md
jklippel 5f022adfc6 Initial version of a Markdown documentation (#221) 
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>
2022-04-23 21:18:08 +02:00

977 B
Raw Blame History

eleventyNavigation
key title parent order
MarkdownFAQ Markdown FAQ Markdown 90

This section contains frequently asked questions regarding the use of Markdown on Codeberg.

Why doesn't my markdown render correctly?

Sometimes markdown is rendered differently on different sides. If your markdown renders correctly on another forge or in your editor but does not get rendered correctly at Codeberg, it is probably due to a difference in the Markdown flavour used by the side/editor.

Codeberg uses Gitea at it's core. Gitea uses Goldmark as rendering engine. Goldmark is compliant with CommonMark 0.30.

Please refer to the CommonMark 0.30 specification on what gets rendered and why.

If you want to correct your rendering you either have to adapt to Codebergs rendering or you must find another way to find an approach common to platforms/software used (and/or supported) by you.