How to write a markdown?
This is a demo of what you can do in a markdown file.
View the markdown used to create this post.
Basics
This is a paragraph, it’s surrounded by whitespace.
Use two trailing spaces
on the right
to create linebreak tags
Next up are some headers:
A subtitle
Header level 3
Lists
- A bulletted list
- an indented list item
- Second element
I need to add another paragraph below the second list item. - A third element.
- An
- ordered
- list
Markup styles
- italics or italics
- bold
code()strikethrough
Code
for k in range(10):
print('hello world!')
Quotes
Blockquote
Nested Blockquote
Quotes and other elements
- item A.
- item B.
Everything works as expected.
Footnotes
Here’s a simple footnote1, and here’s a longer one2.
Tables
| Left aligned | Center aligned | Right aligned |
|---|---|---|
| A | True | 23.99 |
| B | True | 23.99794882 |
- :- means the column is left aligned.
- -: means the column is right aligned.
- :-: means the column is center aligned.
Vertical bars don’t need to be aligned in markdown. Besides, you can also format text in your tables:
| Left aligned | Center aligned | Right aligned |
|---|---|---|
| A | True | 23.99 |
| B | True | 23.99794882 |
Horizontal lines
Links
A link to an external website.
An email: fake@example.com.
A reference to a section.
You can also emphasis a reference (here with italics).
You can change the label used to refer to a section.
And a reference to another page of the website.
You can also use reference-style links: here is an example.
You can use links to make a table of contents:
Images
An image, located within docs/images:
Escaping special characters
* Without the backslash, this would be a bullet in an unordered list.
Advanced
There are some useful things that Markdown doesn’t support. Here are some workarounds:
Underline
This text is underlined.
Indent
Every “ ” is replaced by a white space.
This can also be used to jump
two lines.
Center
Color
This text is red!Image size and caption