Markdown

Examples

Admonitions

Note

This is a note admonition. Use it to provide helpful information.

Warning

This is a warning admonition. Be careful!

Details

Click to expand for more info

This content is hidden until you click to expand it. Great for FAQs or long explanations.

Code Blocks

Code blocks

def greet(name):
    print(f"Hello, {name}!") # (1)!

greet("Python")

Go to documentation

Code annotations allow to attach notes to lines of code.

Code can also be highlighted inline: #!python print("Hello, Python!").

Content tabs

PythonRust

print("Hello from Python!")

println!("Hello from Rust!");

Diagrams

graph LR
  A[Start] --> B{Error?};
  B -->|Yes| C[Hmm...];
  C --> D[Debug];
  D --> B;
  B ---->|No| E[Yay!];

Footnotes

Here's a sentence with a footnote.¹

Hover it, to see a tooltip.

Formatting

==This was marked (highlight)==
^^This was inserted (underline)^^
~~This was deleted (strikethrough)~~
H~2~O
A^T^A
++ctrl+alt+del++

Icons, Emojis

:sparkles:
:rocket:
:tada:
:memo: :memo:
:eyes:

Maths

\[ \cos x=\sum_{k=0}^{\infty}\frac{(-1)^k}{(2k)!}x^{2k} \]

Needs configuration

Note that MathJax is included via a script tag on this page and is not configured in the generated default configuration to avoid including it in a pages that do not need it. See the documentation for details on how to configure it on all your pages if they are more Maths-heavy than these simple starter pages.

Task Lists

Install Zensical
Configure zensical.toml
Write amazing documentation
Deploy anywhere

Tooltips

Hover me

Markdown in 5min

Headers

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

Text formatting

**bold text**
*italic text*
***bold and italic***
~~strikethrough~~
`inline code`

Links and images

[Link text](https://example.com)
[Link with title](https://example.com "Hover title")
![Alt text](image.jpg)
![Image with title](image.jpg "Image title")

Lists

Unordered:
- Item 1
- Item 2
  - Nested item

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

Blockquotes

> This is a blockquote
> Multiple lines
>> Nested quote

Code blocks

```javascript
function hello() {
  console.log("Hello, world!");
}
```

Tables

| Header 1 | Header 2 | Header 3 |
|----------|----------|----------|
| Row 1    | Data     | Data     |
| Row 2    | Data     | Data     |

Horizontal rule

---
or
***
or
___

Task lists

- [x] Completed task
- [ ] Incomplete task
- [ ] Another task

Escaping characters

Use backslash to escape: \* \_ \# \`

Line breaks

End a line with two spaces  
to create a line break.

Or use a blank line for a new paragraph.

This is the footnote. ↩