Skip to content

Latest commit

 

History

History
241 lines (170 loc) · 3.69 KB

writing.md

File metadata and controls

241 lines (170 loc) · 3.69 KB

Writing Markdown

MkDocs supports regular Markdown syntax with some Github Flavored Markdown extensions.

For other references on writing in Markdown, see the GitHub documentation, the Markdown Guide, or the author's original documentation.

The rest of this page provides a reference guide to the supported markdown syntax.

Headings

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

H1

H2

H3

H4

H5

Formatting

* **Bold text**
* *Italic text*
* ~~Strikethrough~~
* <ins>Underlined</ins>
* e <sup>i π</sup> = -1
* H<sub>2</sub>O

  • Bold text
  • Italic text
  • Strikethrough
  • Underlined
  • e i π = -1
  • H2O

Lists

- First item
- Second item
- Third item

  • First item
  • Second item
  • Third item

## Ordered Lists

1. First item
2. Second item
3. Third item

  1. First item
  2. Second item
  3. Third item

Links

See [wikipedia](https://www.wikipedia.org/).

See wikipedia.

Section links

See the [Links](#links) section.

See the Links section.

Relative Links

Back to the [Homepage](index.md).

Back to the Homepage.

Images

![coder cat](img/codercat.png)

coder cat

Inline Code

`&mdash;`

&mdash;

Code Block

```json
{
  "firstName": "John",
  "lastName": "Smith",
  "age": 25
}
```

{
  "firstName": "John",
  "lastName": "Smith",
  "age": 25
}

Horizontal Rule

---

Table

| Syntax    | Description |
| --------- | ----------- |
| Header    | Title       |
| Paragraph | Text        |

Syntax Description
Header Title
Paragraph Text

Footnotes

Here's a sentence with a footnote. [^1]

[^1]: This is the footnote from earlier.

Here's a sentence with a footnote. 1

Blockquote

> Rumors of my death have been greatly exaggerated.

Rumors of my death have been greatly exaggerated.

Alerts

> [!NOTE]
> Useful information that users should know, even when skimming content.

Note

Useful information that users should know, even when skimming content.

> [!TIP]
> Helpful advice for doing things better or more easily.

Tip

Helpful advice for doing things better or more easily.

> [!IMPORTANT]
> Key information users need to know to achieve their goal.

Important

Key information users need to know to achieve their goal.

> [!WARNING]
> Urgent info that needs immediate user attention to avoid problems.

Warning

Urgent info that needs immediate user attention to avoid problems.

> [!CAUTION]
> Advises about risks or negative outcomes of certain actions.

Caution

Advises about risks or negative outcomes of certain actions.

Emoji

:+1: This PR looks great :heart:

👍 This PR looks great ❤️

Task List

- [x] Write the press release
- [ ] Update the website
- [ ] Contact the media

  • Write the press release
  • Update the website
  • Contact the media

Footnotes

  1. This is the footnote from earlier. ↩