Docco

Instant documentation for your HTML.

Docco is an open-source documentation platform that instantly turns your HTML files into a searchable, navigable documentation site. It is designed for speed, simplicity, and extensibility, making it easy to publish and maintain documentation for any project.

Features

• ⚡ Instant Import: Convert HTML files into a beautiful documentation site in seconds.
• 🔍 Full-Text Search: Blazing-fast search powered by Meilisearch.
• 🧭 Automatic Navigation: Sidebar navigation is generated from your folder structure.
• 🖥️ Modern UI: Responsive, accessible, and customizable interface built with Next.js and Tailwind CSS.

Getting Started

Prerequisites

• Node.js (18+ recommended)
• Bun (for CLI and development)
• Docker (for running Meilisearch)

1. Clone the Repository

git clone https://github.com/yourusername/docco.git
cd docco

2. Local Meilisearch

Create initial environment variables

cp .env.example .env
cp web/.env.example web/.env

Create a meilisearch master key and update

• MEILISEARCH_MASTER_KEY in .env.
• MEILISEARCH_API_KEY in web/.env.

Start meilisearch with

docker-compose up -d

3. Start web app

Install dependencies and start web app

cd web
bun install
bun run dev

Open http://localhost:3000 in your browser.

4. Import Your Documentation

Use the CLI to import your HTML files:

cd ../cli
bun install
bun run index.ts content:create ./path/to/your/html

Contributing

Contributions are welcome! Please open issues or pull requests.

License

MIT