Open Offline Docs

Docker-based offline documentation system for open-source frameworks and languages.

Table of Contents

• Overview
• Features
• Quick Start
• Installation
  • System Dependencies
  • Project Setup
• Usage
  • Commands
  • Terminal UI
  • HTTP API
• Configuration
• Testing
• Documentation
• License

Overview

Run documentation servers for popular frameworks and languages entirely offline. Each documentation site runs in an isolated Docker container, managed via a Terminal UI or HTTP API.

Docs included: FastAPI, Alpine.js, Astro, PHP, Python, SlimPHP

Quick Start

# Check dependencies
bash ood doctor

# Build Docker images
bash ood build

# Start services
bash ood up

# Open Terminal UI
bash ood tui

Installation

System Dependencies

Before using Open Offline Docs, ensure these are installed on your system:

Dependency	Required	Purpose	Install
Docker	Yes	Container runtime	Download
docker-compose	Yes	Multi-container orchestration	Install
Python 3	Yes	Manager service (container control)	Download
curl	Yes	HTTP API testing	Install
Bun	Optional	Terminal UI runtime	Install

Verify all dependencies:

bash ood doctor

Project Setup

1. Clone the repository:

   git clone https://github.com/BOLD-ENGINEERING/open.offline.docs.git
   cd open.offline.docs

2. (Optional) Configure base directory:

   cp .env.example .env
   # Edit .env and set BASE_DIR to your absolute path

3. Build Docker images:

   bash ood build

4. Start services:

   bash ood up

Usage

Commands

All commands use the ood script:

# System
bash ood doctor          # Check system dependencies
bash ood build         # Build Docker images

# Services
bash ood up            # Start all services
bash ood up --only api  # Start only API
bash ood down          # Stop all services
bash ood status        # Show container status
bash ood clean         # Stop and prune containers

# Info
bash ood list           # List available docs
bash ood help          # Show help
bash ood tui           # Open Terminal UI

Terminal UI

Launch the interactive TUI:

bash ood tui

Navigate with vim keys:

Key	Action
j / ↓	Navigate down
k / ↑	Navigate up
Enter	Execute
q / Esc	Quit

HTTP API

Start the API service, then use:

# List all docs
curl http://127.0.0.1:8080/docs

# Start a doc
curl -X POST http://127.0.0.1:8080/docs/fastapi/start

# Stop a doc
curl -X POST http://127.0.0.1:8080/docs/fastapi/stop

# Get doc status
curl http://127.0.0.1:8080/docs/fastapi/status

Configuration

Environment variables (optional):

Variable	Used By	Description
BASE_DIR	ood, TUI	Absolute path to project root
OOD_DOCS_PATH	manager	Path to docs directory

Testing

See tests/README.md for test documentation.

# Verify dependencies
bash ood test --dep

# Test API endpoints (requires API running)
bash ood test --api

Documentation

See AGENTS.md for developer guidelines and architecture details.

License

GPL v3. See LICENSE.