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

Let me try to break the issues up in smaller ones.

Personally, I think this are too many files. [...]

So you are saying rather a long article than smaller ones.

My thoughts on creating these files were:

• Keep the articles short, so that someone new to Markdown is not frustrated by a long article.
• Create seperate articles as some example-renderings clearly oppose a well-structured document.
• There currently is no search, so the brain has to do so searching when scanning the index/content in the sidebar. Best to show relevant topics there.

There are already many markdown docs, also by the linked CommonMark, I think we should rather reference those.

There are already reference (as you already pointed out) in the documentation.
I would favour to have a small introduction to markdown in the Codeberg documentation anyway. If someone is really new to Codeberg and Markdown it is best to have the documentation at hand and in one place.

I also think it is already complete for a short introduction. Further documentation could be linked if there is nothing basic I actually forgot.

Noteworthy: Gitea rendering in repos and comment fields is different (e.g. simple line breaks are considered in the comments), so this should be noted. Also interesting are Gitea-specials like :codeberg: :gitea: via :codeberg: :gitea:, embedding e.g. Mermaid diagrams, referencing issues and pulls via #NR, using checkboxes for ToDo lists that can even be clicked when not in the edit mode to mark them as checked etc

I agree, I will add it to the introduction article.

By the way: I recommend to make a line break in Markdown at logical steps, e.g. sentence ends. It makes diffs much more clear, because you get which setentences (/ parts of it when > 80char) where changed. If you agree, you can also recommend that.

I agree too. Will lead to some reformatting. :)

Short Off-Topic-Rant (and explanation why I just accidentally closed this issue):
Ok, this is bad UX. You write a comment and you decide that you want to "not comment" anymore (withdraw what you have just written). The logical thing to do is to click the "Close" button on the comment... Unfortunately this closes the issue. 🙄

I am not happy with cd7005d428ee78b7ecc76655067bd34663476d2a. Unfortunately the documentation does not render :codeberg:, so I had to add it as image. Unfortunately both images are resized by the browser. I added the smaller versions to the assets directory but the documentation renders a grey border around it. It does not look like the original at all.

@fnetX Updated the emoticon section with a1bb900966ca69f363795f2e2a258979efe365d4 . Could you have another look. I am not sure whether it is a good idea to link to gitea using the image. It would make an impression on their site every time someone looks at the Codeberg documentation. What do you think?

Rebased to current main (7fd05707f2)