6.3 KiB
Admonitions
⚠️ Warning: This is a warning.
📝 Note: This is a note.
💡 Tip: This is a tip.
GitHub Admonitions
Note
This is a note.
Tip
This is a tip.
Important
This is important.
Warning
This is a warning.
Caution
This is a caution.
python-markdown Admonitions
!!! note "This is a note." Hello World!
!!! danger "This is a danger." Hello World!
!!! important "This is important." Hello World!
!!! warning "This is a warning." Hello World!
!!! caution "This is a caution." Hello World!
The section below is an excerpt of the original. The original content is licensed under a CC BY-SA 4.0 license. The original content can be found at the link above.
Headings
Heading level 1
Heading level 2
Heading level 3
Heading level 4
Heading level 5
Heading level 6
Alternate Syntax
Heading level 1
Heading level 2
Paragraphs
I really like using Markdown.
I think I'll use it to format all of my documents from now on.
Line Breaks
This is the first line.
And this is the second line.
Emphasis
I just love bold text.
I just love bold text.
Loveisbold
Italicized text is the cat's meow.
Italicized text is the cat's meow.
Acatmeow
This text is really important.
This text is really important.
This text is really important.
This text is really important.
This is reallyveryimportant text.
Blockquotes
Dorothy followed her through many of the beautiful rooms in her castle.
Dorothy followed her through many of the beautiful rooms in her castle.
The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.
Dorothy followed her through many of the beautiful rooms in her castle.
The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.
The quarterly results look great!
- Revenue was off the chart.
- Profits were higher than ever.
Everything is going according to plan.
Lists
List 1
- First item
- Second item
- Third item
- Fourth item
List 2
- First item
- Second item
- Third item
- Fourth item
List 3
- First item
- Second item
- Third item
- Fourth item
List 4
- First item
- Second item
- Third item
- Indented item
- Indented item
- Fourth item
List 5
- First item
- Second item
- Third item
- Fourth item
List 6
- First item
- Second item
- Third item
- Fourth item
List 7
- First item
- Second item
- Third item
- Fourth item
List 8
- First item
- Second item
- Third item
- Indented item
- Indented item
- Fourth item
List 9
- 1968. A great year!
- I think 1969 was second best.
Paragraphs
-
This is the first list item.
-
Here's the second list item.
I need to add another paragraph below the second list item.
-
And here's the third list item.
-
This is the first list item.
-
Here's the second list item.
A blockquote would look great below the second list item.
-
And here's the third list item.
Code Blocks
-
Open the file.
-
Find the following code block on line 21:
<html> <head> <title>Test</title> </head> -
Update the title to match the name of your website.
Images
-
Open the file containing the Linux mascot.
-
Marvel at its beauty.
-
Close the file.
Code
At the command prompt, type nano.
Use `code` in your Markdown file.
<html>
<head>
</head>
</html>
Horizontal Rules
Links
My favorite search engine is Duck Duck Go.
My favorite search engine is Duck Duck Go.
I love supporting the EFF.
This is the Markdown Guide.
See the section on code.
In a hole in the ground there lived a hobbit. Not a nasty, dirty, wet hole, filled with the ends of worms and an oozy smell, nor yet a dry, bare, sandy hole with nothing in it to sit down on or to eat: it was a hobbit-hole, and that means comfort.
Escaping Characters
* Without the backslash, this would be a bullet in an unordered list.
\ test
` test
* test
_ test
{ test
} test
[ test
] test
< test
> test
( test
) test
# test
+ test
- test
. test
! test
| test
HTML
This word is bold. This word is italic.
Tables
| Syntax | Description |
|---|---|
| Header | Title |
| Paragraph | Text |
| Syntax | Description |
|---|---|
| Header | Title |
| Paragraph | Text |
| Syntax | Description | Test Text |
|---|---|---|
| Header | Title | Here's this |
| Paragraph | Text | And more |
Fenced Code Blocks
{
"firstName": "John",
"lastName": "Smith",
"age": 25
}
{
"firstName": "John",
"lastName": "Smith",
"age": 25
}
Footnotes
Here's a simple footnote,1 and here's a longer one.2
Heading IDs
Heading level 1
Heading level 2
Heading level 3
Heading level 4
Heading level 5
Heading level 6
Strikethrough
The world is flat. We now know that the world is round.
Task Lists
- Write the press release
- Update the website
- Contact the media
Emoji
Gone camping! ⛺ Be back soon.
That is so funny! 😂
Highlight
I need to highlight these ==very important words==.
Subscript and Superscript
H2O
X^2^
Disabling Automatic URL Linking
http://www.example.com