Welcome¶

Welcome to my central knowledge base! This site serves as the definitive source for my documentation, references, and system configurations.

Quick Zensical Reference¶

Admonitions¶

General Info¶

Note

Provide helpful, persistent information that doesn't necessarily belong in the main text.

Info

Highlighting facts or additional context that adds value to the reader.

Tip

Pro-tips, shortcuts, or clever ways to achieve a goal.

Question

FAQs, things to consider, or when prompting the user for input.

Validation¶

Success

Indicate a completed task, a positive outcome, or a "correct" state.

Example

Concrete illustrations or code snippets that clarify a concept.

Abstract

Summaries, TL;DRs, or an overview of the content to follow.

Quote

Citations, testimonials, or highlighting a specific statement.

Warnings¶

Warning

Proceed with caution.

Failure

Indicate something went wrong, an operation failed, or a negative outcome occurred.

Bug

Document known issues, edge cases, or errors in software/logic.

Danger

Critical warnings where data loss, security risks, or hardware damage might occur.

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: 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₂O
A^TA
Ctrl+Alt+Del

Icons, Emojis¶

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

This is the footnote. ↩