Finish the Markdown reference/tutorial

[kazk]

• markdown home page
• extensions page (reference)
• some sort of tutorial, but where/in what section? (see message below) -> will be added somewhere else, see below

---

#62 added a stub page for basic Markdown syntax and we need to complete it. The page should be minimal and easy to scan. Any nonstandard Markdown features were extracted into a separate page.

Basic Markdown that most users use is extremely simple and should focus on that. For example, GitHub's Markdown Cheat Sheet looks like this:

Include the syntax for:

• Emphasis
• Code Block
• Lists
• Links
• Blockquotes

I'm not sure if it's worth including the result. For most of them, it'll look very similar to the original syntax and it's pretty obvious. It can look slightly different on Codewars because different libraries are used and CSS is different. For Headers, it'll also mess with the table of contents as well.

[Blind4Basics]

about the math part: codewars/codewars.com#1527 (archiving)
related #27

[Blind4Basics]

I'm planning on doing the extensions page as a reference, so I'll prune it from some tiny parts (for now I'll keep them commented out for later).

Thing is, I'd like to create a tutorial about markdown, but I'm not sure how to tackle it, since it can be usefull for creating kata (description) as well as for comments.
Hence, simpler course of action should be, I guess, to make it a stand alone thing, but I feel it a bit weird at the same time. Any thoughts? (Maybe I'll just give it a shot in some time and we'll see after that?)

[Blind4Basics]

Up here! To see if we close this one or not.

• Do you (plural) think we need a tutorial or recipe about markdowns yet?
• If so, do we make it a stand alone thing, or do we rather incorporate it to something else (like, writing descriptions)?

(current state of the docs about markdowns: https://docs.codewars.com/references/markdown/#basic-markdown-syntax )

[kazk]

Not really for Markdown itself, but I think we should have something for "how to write comments effectively" and also "how to write kata descriptions". For kata description, we should have some recommended style (what to include, how to structure, etc).

[Blind4Basics]

ok, I'll open a temporary "todo" issue to kee track of this.

👍