Skip to content

TorstenDittmann/docia

Repository files navigation

docia

Documentation that works. For humans. And machines.

Generate beautiful, fast, SEO-ready documentation sites from Markdown.

Features

  • Fast development — Live reload on every save
  • SEO-first — Sitemap, structured data, canonical URLs, robots.txt out of the box
  • Clean navigation — Simple chapter structure via SUMMARY.md
  • LLM-readyllms.txt + per-page markdown for AI assistants
  • Static export — Host anywhere (Vercel, Netlify, GitHub Pages, S3)

Quick Start

# Install docia (macOS/Linux)
curl -fsSL https://docia.xyz/install.sh | sh

# Create a new docs project
docia init my-docs
cd my-docs

# Start development server
docia dev

Your docs will be available at http://localhost:3000.

Installation

Option 1: Standalone Executable (Recommended)

No dependencies required. Works on macOS, Linux, and Windows.

# Install via install script (macOS/Linux)
curl -fsSL https://docia.xyz/install.sh | sh

# Windows users: download manually from GitHub Releases
# https://github.com/docia/docia/releases/latest

Option 2: npm (with Bun runtime)

Requirements: Bun 1.3+

# Install globally
bun install -g docia

# Or use directly with bunx
bunx docia --help

Usage

# Initialize a new project
docia init my-docs

# Development with live reload
docia dev

# Build for production
docia build

# Validate before deploy
docia check

Documentation

Full documentation: docia.xyz (built with docia)

Or run the docs locally:

git clone https://github.com/yourusername/docia
cd docia
bun install
bun run src/cli.ts dev --config docs/docia.config.ts

Example

See examples/team-handbook/ for a complete documentation site example.

Contributing

See CONTRIBUTING.md for development setup and contribution guidelines.

About

Documentation that works. For humans. And machines.

Resources

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors