Skip to content

Zensical Markdown Cheatsheet

Zensical-specific syntax beyond standard Markdown. For more in-depth explanations, see the Zensical documentation.

Each section below shows the source you write and the rendered result.

Admonitions

Go to documentation

Source

1
2
3
4
5
6
7
!!! note

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

!!! warning

    This is a **warning** admonition. Be careful!

Rendered

Note

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

Warning

This is a warning admonition. Be careful!

Collapsible Details

Go to documentation

Source

1
2
3
4
??? info "Click to expand for more info"

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

Use ???+ instead of ??? to make the block open by default.

Rendered

Click to expand for more info

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

Code blocks

Go to documentation

Source

1
2
3
4
5
6
7
8
``` python hl_lines="2" title="Code blocks"
def greet(name):
    print(f"Hello, {name}!") # (1)!

greet("Python")
```

1.  Code annotations allow to attach notes to lines of code.

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

Rendered

Code blocks
1
2
3
4
def greet(name):
    print(f"Hello, {name}!") # (1)!

greet("Python")

  1. Go to documentation

    Code annotations allow to attach notes to lines of code.

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

Content tabs

Go to documentation

Source

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
=== "Python"

    ``` python
    print("Hello from Python!")
    ```

=== "Rust"

    ``` rs
    println!("Hello from Rust!");
    ```

Rendered

1
print("Hello from Python!")

1
println!("Hello from Rust!");

Diagrams

Go to documentation

Source

1
2
3
4
5
6
7
8
``` mermaid
graph LR
  A[Start] --> B{Error?};
  B -->|Yes| C[Hmm...];
  C --> D[Debug];
  D --> B;
  B ---->|No| E[Yay!];
```

Rendered

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

Footnotes

Go to documentation

Source

1
2
3
4
5
Here's a sentence with a footnote.[^1]

Hover it, to see a tooltip.

[^1]: This is the footnote.

Rendered

Here's a sentence with a footnote.1

Hover it, to see a tooltip.

Formatting

Go to documentation

Source

1
2
3
4
5
6
- ==This was marked (highlight)==
- ^^This was inserted (underline)^^
- ~~This was deleted (strikethrough)~~
- H~2~O
- A^T^A
- ++ctrl+alt+del++

Rendered

  • This was marked (highlight)
  • This was inserted (underline)
  • This was deleted (strikethrough)
  • H2O
  • ATA
  • Ctrl+Alt+Del

Icons, emojis

Go to documentation

Source

1
2
3
4
5
* :sparkles: `:sparkles:`
* :rocket: `:rocket:`
* :tada: `:tada:`
* :memo: `:memo:`
* :eyes: `:eyes:`

Rendered

  • ✨ :sparkles:
  • 🚀 :rocket:
  • 🎉 :tada:
  • 📝 :memo:
  • 👀 :eyes:

Maths

Go to documentation

Source

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

Needs configuration

MathJax is included via a script tag on this page and is not configured in the generated default configuration to avoid including it on 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 this example.

Rendered

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

Task lists

Go to documentation

Source

1
2
3
4
* [x] Install Zensical
* [x] Configure `zensical.toml`
* [x] Write amazing documentation
* [ ] Deploy anywhere

Rendered

  • Install Zensical
  • Configure zensical.toml
  • Write amazing documentation
  • Deploy anywhere

Tooltips

Go to documentation

Source

1
2
3
[Hover me][example]

  [example]: https://example.com "I'm a tooltip!"

Rendered

Hover me

  1. This is the footnote. ↩