Using Zensical

Zensical is a newer replacement for Material for MkDocs. You can rapidly build sites with Markdown.

Markdown was created by John Gruber

The below is auto-generated from Zensical, but still serves as a handy reference.

Headers¶

# H1 Header
## H2 Header
### H3 Header
#### H4 Header
##### H5 Header
###### H6 Header

Text formatting¶

**bold text**
*italic text*
***bold and italic***
~~strikethrough~~
`inline code`

Links and images¶

[Link text](https://example.com)
[Link with title](https://example.com "Hover title")
![Alt text](image.jpg)
![Image with title](image.jpg "Image title")

Lists¶

Unordered:

- Item 1
- Item 2
- Nested item

Ordered:

1. First item
2. Second item
3. Third item

Blockquotes¶

> This is a blockquote
> Multiple lines
>> Nested quote

Code blocks¶

```javascript
function hello() {
console.log("Hello, world!");
}
```

Tables¶

| Header 1 | Header 2 | Header 3 |
|----------|----------|----------|
| Row 1    | Data     | Data     |
| Row 2    | Data     | Data     |

Horizontal rule¶

---
or
***
or
___

Task lists¶

- [x] Completed task
- [ ] Incomplete task
- [ ] Another task

Escaping characters¶

Use backslash to escape: \* \_ \# \`

Line breaks¶

End a line with two spaces  
to create a line break.

Or use a blank line for a new paragraph.

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¶

Go to documentation

Details¶

Go to documentation

Code Blocks¶

Go to documentation

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

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

Formatting¶

Go to documentation

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

Icons, Emojis¶

Go to documentation

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

Maths¶

Go to documentation

Task Lists¶

Go to documentation

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

Tooltips¶

Go to documentation

1. Set up your repo on Github (works similarly for Gitlab or others)
2. In Cloudflare, add a new project using a Worker (Compute Workers & Pages)
   • ensuring your Github repo is available to Cloudflare by connecting your account
3. Add pip install zensical && zensical build to the build settings
4. Run the deploy and check out your site!
   • Cloudflare gives you a URL on your account subdomain
   • You can add a custom domain later. If you registered your domain with Cloudflare, it's a 1-click setup.