Skip to content

Latest commit

 

History

History
97 lines (71 loc) · 2.25 KB

File metadata and controls

97 lines (71 loc) · 2.25 KB

Writing Documentation in Markdown

Markdown is a lightweight markup language with plain text formatting syntax. Markdown is often used to format readme files, for formatting messages in online discussion forums, and to create rich text using a plain text editor. Markdown is a popular format for writing documentation alongside code along with other markup languages like reStructuredText, AsciiDoc, and Textile.

There are several different dialects of Markdown, including John Gruber's original specification, the CommonMark specification, and GitHub Flavored Markdown. You can think of these dialects as flavors of Markdown. Each flavor has its own unique features that set it apart from the others - for example some flavors support table syntax while others do not.

Some popular platforms that support writing & formatting using Markdown syntax include GitHub, Reddit, Stack Exchange, Slack and Discord.

Basic Syntax

Headers

# H1
## H2
### H3
#### H4
##### H5
###### H6

Emphasis

*italic*
_italic_
**bold**
__bold__
~~strikethrough~~

Lists

- item 1
- item 2
- item 3
1. item 1
2. item 2
3. item 3

Links

[link text](https://example.com)

Images

![alt text](https://example.com/image.png)

Code

`inline code`
    ```python
    def hello_world():
        print("Hello, world!")
    ```

Tables

| Column 1 | Column 2 | Column 3 |
| -------- | -------- | -------- |
| Row 1    | Row 1    | Row 1    |
| Row 2    | Row 2    | Row 2    |
| Row 3    | Row 3    | Row 3    |

Blockquotes

> blockquote

Horizontal rules

---

References