Holocron offers an open-source, drop-in replacement for Mintlify, functioning as a Vite plugin to generate documentation sites from MDX files and a docs.json configuration. It targets developers seeking a self-hosted, locally buildable, and cost-effective alternative to cloud-based documentation platforms, enabling rapid migration from existing Mintlify projects and providing AI agent integration.

How It Works

Holocron integrates as a Vite plugin, automatically incorporating the Spiceflow framework for React Server Components and Tailwind CSS. It processes MDX pages and a docs.json configuration file to construct a complete documentation website. This approach allows for local development builds and standard CI/CD deployment pipelines, offering greater flexibility and control compared to cloud-only solutions. The plugin intelligently caches processed files based on Git SHAs for efficient rebuilds.

Quick Start & Requirements

• Scaffold New Project: npx -y @holocron.so/cli create
• Manual Setup: pnpm add @holocron.so/vite react react-dom vite
• Prerequisites: Vite, React, React DOM. The plugin automatically includes Spiceflow and Tailwind CSS.
• Development: Run pnpm install && pnpm dev after scaffolding or npx vite for manual setup.
• Production Build: npx vite build
• Documentation: Full documentation is available at holocron.so.

Highlighted Details

• Mintlify compatibility: Supports same docs.json schema, MDX components, and frontmatter fields for seamless migration.
• Local development and builds via Vite, enabling self-hosting on any platform supporting Node.js or Cloudflare Workers.
• Integrated search powered by Orama, offering zero-configuration local search.
• AI-readable documentation endpoints (.md routes, /llms.txt, /docs.zip, skill discovery) for agent integration.
• Generation of OpenAPI reference pages directly from specs.
• Built-in dark mode with system detection and manual toggle.

Maintenance & Community

The provided README does not detail specific contributors, sponsorships, or community channels like Discord or Slack. However, the availability of a CLI tool and active development signals suggest ongoing maintenance.

Licensing & Compatibility

• License: MIT.
• Compatibility: The permissive MIT license allows for commercial use and integration within closed-source projects.

Limitations & Caveats

The API reference generated is read-only, differing from Mintlify's interactive playground. Built-in analytics are not provided, requiring users to implement their own solutions. Custom domain management relies on the chosen hosting provider rather than a dedicated dashboard feature. Builds are performed locally, necessitating a CI/CD setup for automated deployments.