Skip to content

CAL Documentation Server

A lightweight, fast documentation server built with Python and aiohttp. Serves static HTML documentation with automatic indexing, version management, markdown rendering, and a REST API for programmatic access and uploads.

Features

  • Live Search - Real-time project filtering on the index page as you type
  • Automatic Indexing - Generates a beautiful index page for all documentation projects
  • Version Management - Supports multiple versions of the same documentation with automatic "Latest" redirection
  • Markdown Support - Renders .md files on-the-fly with syntax highlighting
  • Smart Logo Detection - Automatically displays project logos from docinfo.png/jpg/svg
  • Dark Theme - Modern, responsive dark theme with collapsible version lists
  • REST API - Programmatic access to list, search, download, upload, and delete documentation
  • Token Authentication - Secure uploads and deletes with configurable API tokens
  • Fast & Async - Built on aiohttp for high-performance async I/O

Quick Start

Running Locally

python3 -m cal_docs_server -d /path/to/docs --port 8080 --name "My Docs"