Zensical Tips

Admonitions

Call outs examples, can use Octocons and Fontawesome icons.

Inline Admonitions

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa. This text wraps around the inline admonition.

Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante.

Buttons

Use styled buttons for calls to action:

Choose A Bike :material-rocket-launch: GitHub Repository :fontawesome-brands-github: Practicalli Website

Icons

Icon sets are bundled with Zensical. Practicalli web sites mostly use Lucide for general icons and Octocons for GitHub specific icons.

Lucide Octicons

Material Design FontAwesome Simple Icons

Tool tips

The API endpoint processes requests through multiple stages.

*[API]: Application Programming Interface - A way for applications to communicate

TODO: check if plugin required for tooltips

Hyperlinks

Link with Preview. by adding { data-preview } style after the URL

[Link with Preview](bike-fit.md){ data-preview }

Zensical supports hoverable tooltips using the title attribute.

[hoverable tooltips](https://zensical.org "Click to learn more about Zensical!")

Reference-style Links

Use a reference style link where there are multiple links on a page for one URL.

Our data API and metadata system.

Images

Place a ! character in front of a hyperlink form, with the URL being the address of the image and the text being the 'Alternative Text' (if they image does not download )

Image with Caption

Image Grid

Keyboard Keys

Use Ctrl+Shift+R to hard refresh your browser and clear the favicon cache.

Common ETL commands:

• Run a step: Ctrl+Enter
• Stop execution: Ctrl+C
• Search documentation: Ctrl+K or Cmd+K

Progress Bars

Track your ETL learning progress:

75% Complete

Dataset processing status:

Snapshot ✓

Meadow ✓

Garden

Grapher

Footnotes

TODO: check if footnotes needs a plugin or uses different syntax

The ETL pipeline[^1] processes data from multiple international organizations[^2] and makes it available through our API[^3].

[^1]: ETL stands for Extract, Transform, Load - the three core stages of data processing.

[^2]: Major data providers include:

- World Health Organization (WHO)
- World Bank
- United Nations
- OECD
- National statistical agencies

[^3]: Our REST API provides programmatic access to all OWID datasets. See the API documentation for details.

Mermaid Diagrams

Flow Chart

graph LR
    A[Input] -->|Raw Data| B[Processing]
    B -->|Cleaned| C[Transform]
    C -->|Validated| D[Storage]
    D -->|Published| E[Output]

    style A fill:#f9f,stroke:#333
    style E fill:#9f9,stroke:#333

Sequence Diagram

sequenceDiagram
    participant User
    participant App
    participant Database
    participant API

    User->>App: Request data update
    App->>Database: Check current version
    Database-->>App: Version info
    App->>App: Process new data
    App->>Database: Store updated data
    Database-->>App: Success
    App->>API: Refresh cache
    API-->>User: Updated data available

System Architecture

graph TB
    subgraph "Data Sources"
        S1[API Source]
        S2[File Upload]
        S3[Database]
    end

    subgraph "Processing Pipeline"
        Ingest[Data Ingestion]
        Valid[Validation]
        Trans[Transformation]
        Store[Storage]
    end

    subgraph "Output Layer"
        DB[(Database)]
        API[REST API]
        UI[Web Interface]
    end

    S1 --> Ingest
    S2 --> Ingest
    S3 --> Ingest
    Ingest --> Valid
    Valid --> Trans
    Trans --> Store
    Store --> DB
    DB --> API
    DB --> UI