主页⚓︎

For full documentation visit zensical.org.

Commands⚓︎

zensical new - Create a new project
zensical serve - Start local web server
zensical build - Build your site

Examples⚓︎

Admonitions⚓︎

!!! note

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

!!! warning

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

Details⚓︎

??? info "Click to expand for more info"

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

Code Blocks⚓︎

``` python hl_lines="2" title="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⚓︎

=== "Python"

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

=== "Rust"

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

Diagrams⚓︎

mermaid 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.[^1]

Hover it, to see a tooltip.

[^1]: This is the footnote.

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: :sparkles:
:rocket: :rocket:
:tada: :tada:
:memo: :memo:
:eyes: :eyes:

Maths⚓︎

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

!!! warning "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⚓︎

[x] Install Zensical
[x] Configure zensical.toml
[x] Write amazing documentation
[ ] Deploy anywhere

Tooltips⚓︎

Hover me