Get started¶

Documentation¶

Click a heading, below, to view the official documentation at zensical.org.

Zensical 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!

Collapsible blocks ¶

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")

I’m a code annotation! I can contain code, formatted text, images, … basically anything that can be written in Markdown.

Code annotations offer a way to attach arbitrary content to specific sections of code blocks by adding numeric markers in block and inline comments in the language of the code block. Add the following to your configuration to enable them globally:

zensical.toml

[project.theme]
features = [
  "content.code.annotate",

Code can also be highlighted inline: 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 over the numeral to see the footnote text in a tooltip.

Formatting ¶

This was marked (highlight)
This was inserted (underline)
~~This was deleted (strikethrough)~~
H₂O
A^TA
Ctrl+Alt+Del

Icons, Emojis ¶

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

Math Notation ¶

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

Needs configuration

Note that MathJax is included via an html script tag on this page (shown below) 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 math-heavy than these simple starter pages.

<script id="MathJax-script" src="https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js"></script>

Task Lists ¶

Install Zensical
Configure zensical.toml
Write amazing documentation
Deploy anywhere

Tooltips ¶

Hover me

This is the footnote. ↩