Zensical POC Documentation¶

Welcome to the Zensical Proof of Concept documentation site. This POC demonstrates how Zensical satisfies common documentation requirements.

Overview¶

This documentation is built with Docs-as-Code using Markdown. All content is version-controlled and built via CI/CD.

Key Features Demonstrated¶

• Docs-as-Code — Markdown files in docs/
• Syntax highlighting — Code blocks with language-specific coloring
• Line numbers — Optional line numbering in code snippets
• Copy button — One-click copy for code blocks
• Code annotations — Clickable markers that reveal inline explanations
• Search — Built-in full-text search (use the search bar above)
• Table of Contents — Auto-generated TOC with linkable headers
• Responsive design — Works on mobile and desktop
• Accessibility — Semantic HTML, keyboard navigation, theme support
• Content tabs — Tabbed code blocks for multi-language examples
• Admonitions — Note, warning, tip, and collapsible blocks
• Mermaid diagrams — Sequence, class, and flowchart diagrams

Quick Links¶

Architecture¶

The following diagram shows the documentation build pipeline:

flowchart LR
    subgraph Source
        MD[Markdown Files]
        TOML[zensical.toml]
    end

    subgraph Build
        Zensical[Zensical Build]
    end

    subgraph Output
        HTML[Static HTML Site]
        Site[GitHub Pages]
    end

    MD --> Zensical
    TOML --> Zensical
    Zensical --> HTML
    HTML --> Site

Feature Showcase¶

Admonitions¶

Collapsible Details¶

Code Annotations¶

def greet(name):
    print(f"Hello, {name}!") # (1)!

greet("Python")

1. Code annotations allow to attach notes to lines of code. See the documentation.

Code can also be highlighted inline: print("Hello, Python!").

Content Tabs¶

print("Hello from Python!")

println!("Hello from Rust!");

Formatting¶

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

Task Lists¶

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

Footnotes¶

Here's a sentence with a footnote.¹

Hover it, to see a tooltip.

Getting Help¶

• Internal link: Code Examples — Java
• External link: Zensical Documentation
• Intentionally broken link (for testing dead link detection): Broken Example