added docs dir and markdown documentation

This commit is contained in:
bjt-user 2024-04-29 22:33:54 +02:00
parent 060ef1e19d
commit b1bc3d20d9
2 changed files with 17 additions and 0 deletions

View File

@ -11,3 +11,4 @@ This seems intended by the creators of the language.
then create a slice or slice of maps and append after each deeper level discovered...)
- add docs
- delph deeper into different Markdown implementations (like CommonMark)
- add support for "Setext-style headers"

16
docs/john_gruber.md Normal file
View File

@ -0,0 +1,16 @@
John Gruber is the creator of Markdown.\
He describes the syntax here:\
https://daringfireball.net/projects/markdown/syntax
#### headers
https://daringfireball.net/projects/markdown/syntax#header
> Atx-style headers use 1-6 hash characters at the start \
of the line, corresponding to header levels 1-6.
=> that means header level 6 is the maximum level (vim and bat also do not highlight \
level 7 headings)
But there are also "Setext-style headers" that can only create \
level 1 and 2 headers.