Documentation GitHub MarkDown https://github.github.com/gfm/
Documentation MarkDown https://spec.commonmark.org/0.29/
Wiki https://en.wikipedia.org/wiki/Markdown
Basic Syntax
Name | Soure code Markdown | Output Markdown |
---|---|---|
Hard Line Breaks | Hello (two spaces) World |
Hello World |
Warning: " \ " (at the end of line) also will break line |
Hello\ World |
Hello World |
Hello World |
Hello World |
|
Hello World |
Hello World |
|
" non-breaking space " (from html) | Hello World |
Hello World |
Name | Soure code Markdown | Output Markdown |
---|---|---|
Strong Emphasis (Bold) | **Hello World** | Hello World |
Emphasis (Italic) | *Hello World* | Hello World |
Backslash escapes Ignoring Markdown formatting |
\*Hello World\* | \*Hello World\* |
Warning: Text Color is not supported, but You can try use html |
<p style="color: green">Hello World</p> (This is html) |
Hello World |
ATX headings | # Hello World 1 ## Hello World 2 ### Hello World 3 #### Hello World 4 ##### Hello World 5 ###### Hello World 6 |
Hello World 1Hello World 2Hello World 3Hello World 4Hello World 5Hello World 6 |
Name | Soure code Markdown | Output Markdown |
---|---|---|
Autolinks (Link Destination) |
<https://web.site> | https://web.site |
Link Text |
[Your Text](https://web.site) |
Your Text |
Relative Link | [Your Text](Path/to/other_file.md) | Your Text |
Link To Header A very convenient way: Open file on Github and click your ATX header and you will have open link with header Warning: * Convert link to lowercase letters * Replace each space with '-' * Remove punctuations other than "-" and "_" Because link to header may not work. |
[Your Text](#github-trics) | Your Text |
Name | Soure code Markdown | Output Markdown |
---|---|---|
Images |  | Your Image |
Name | Soure code Markdown | Output Markdown | ||||
---|---|---|---|---|---|---|
Warning: Default for Block Quotes is > Your Text for for each quoted line but this style is more difficult to convert to another style for me |
<blockquote> Hello World </blockquote> (This is html) |
Hello |
||||
Code Spans / Code Block | ``` Hello World ``` |
Hello |
||||
Code With Syntax Highlighting | ```sh Hello World ``` |
Hello |
||||
Warning: Code Block also is the line which contains at the beginning 8 spaces or two tabs.” |
(8 spaces or two tabs) Hello World | Hello |
||||
Simple Table |
| 1 | 2 | |
|
||||
Warning: More advanced table you can try build in html One Cell From The Table In Html |
<table> |
|
||||
Other Example Table In Html | <table><thead><tr><th>External Cell<br><table><thead><tr><th>Middle Cell</th></tr></thead><tbody></tbody></table></th></tr></thead><tbody></tbody></table> |
|
||||
Thematic breaks / Horizontal rule / Line | --- |
1 | 2 | |||||
---|---|---|---|---|---|---|
|
|
Name | Soure code Markdown | Output Markdown |
---|---|---|
Wrapping | <details><summary>Your text</summary><p> ``` Your code ``` </p></details> |
Your text``` Your long code ``` |
I tried also use AsciDoc with Markdown on GitHub, but it not worked or I don’t know how use it.
When I trying open web.asciidoc, web browser trying open to download it.
Documentation AsciiDoc https://github.com/asciidoc/asciidoc/blob/master/doc/asciidoc.txt
Wiki https://en.wikipedia.org/wiki/.adoc
When you trying add new file, try add “ / “.
If you want edit folder, edit file inside this folder and click “Backspace” key on keyboard.