Home
On these pages you will find instructions, exercises, cheat sheets, references, and tutorials. Originally, the material was meant to teach our apprentices in- house a starting point on their quest to obtain new skills and learn new stuff.
Courses are more work instructions for learners of new stuff to guide them to a goal. These link over to the guides - call them memorandums on my journey on a lot of webpages where I gather snips and lines that are worth to be kept and remembered - that are organized by topic.
Meanwhile, this technical documentation might morph towards my personal omnium-gatherum while still trying to be useful for our young learners. Therefore it is and will always be in a flux.
Have Fun!
Now start with whatever interests you the most.
Get started
For full documentation visit zensical.org.
Commands
zensical new- Create a new projectzensical serve- Start local web serverzensical build- Build your site
Examples
Admonitions
Go to documentation
Note
This is a note admonition. Use it to provide helpful information.
Warning
This is a warning admonition. Be careful!
Details
Go to documentation
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
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
Go to documentation
print("Hello from Python!")
println!("Hello from Rust!");
Diagrams
Go to documentation
graph LR
A[Start] --> B{Error?};
B -->|Yes| C[Hmm...];
C --> D[Debug];
D --> B;
B ---->|No| E[Yay!];
Footnotes
Go to documentation
Here's a sentence with a footnote.1
Hover it, to see a tooltip.
Formatting
Go to documentation
- ==This was marked (highlight)==
- ^^This was inserted (underline)^^
- ~~This was deleted (strikethrough)~~
- H~2~O
- A^T^A
- Ctrl+Alt+Del
Icons, Emojis
Go to documentation
:sparkles::rocket::tada::memo:-
:eyes: -
:smile: -
:material-account-circle: -
:fontawesome-regular-face-laugh-wink: -
:octicons-repo-push-24: -
:material-apple-keyboard-command: -
:material-apple-keyboard-option: -
:material-apple-keyboard-control: -
:material-apple-keyboard-shift: -
:material-keyboard-return: -
:material-keyboard-space: - Space+F
++space+f++ - Cmd+F1
++command+f1++
Maths
Go to documentation
$$ \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
Go to documentation
- Install Zensical
- Configure
zensical.toml - Write amazing documentation
- Deploy anywhere
Tooltips
Go to documentation
-
This is the footnote. ↩