Skip to content

Getting Started

This guide walks you through setting up the Zensical POC project locally.

Prerequisites

  • Python 3.8+ (only needed for the mike versioning tool)
  • Zensical CLI — see installation docs

Installation

Step 1: Clone the Repository

git clone https://github.com/your-org/zensical-poc.git
cd zensical-poc

Step 2: Install Zensical

Follow the official installation guide for your platform.

Step 3: Install Dependencies (optional)

If you plan to use versioning via mike:

pip install git+https://github.com/squidfunk/mike.git

Running Locally

Start the development server:

zensical serve

Then open http://127.0.0.1:8000 in your browser. The site will auto-reload when you edit the documentation.

Building the Site

To build static files without serving:

zensical build

Output is written to the site/ directory.

Project Structure

zensical-poc/
├── docs/               # Documentation source (Markdown)
│   ├── index.md
│   ├── getting-started.md
│   ├── code-examples.md
│   ├── accessibility.md
│   └── markdown.md
├── zensical.toml       # Zensical configuration
└── .github/
    └── workflows/
        └── docs.yml    # CI/CD pipeline

Next Steps