Quickstart

Install

bash

1pnpm add @holocron.so/vite react react-dom vite

Create vite.config.ts

123456import { defineConfig } from 'vite'
import { holocron } from '@holocron.so/vite'

export default defineConfig({
  plugins: [holocron()],
})

The plugin auto-adds Spiceflow, Tailwind CSS, and React. You do not need to install or configure them separately.

Create docs.json

Create a docs.json file at the project root:

json

12345678910{
  "name": "My Docs",
  "colors": { "primary": "#6366f1" },
  "navigation": [
    {
      "group": "Getting Started",
      "pages": ["index"]
    }
  ]
}

Write your first page

Create index.mdx:

mdx

123456789---
$schema: https://holocron.so/frontmatter.json
title: Welcome
description: My documentation site.
---

# Welcome

This is my first Holocron page.

Run the dev server

bash

1npx vite

Open http://localhost:5173 and you should see your docs site.

Build for production

bash

1npx vite build

Start the production server:

bash

1node dist/rsc/index.js

Project structure

A minimal Holocron project looks like this:

diagram

my-docs/
├── index.mdx
├── docs.json
├── vite.config.ts
├── package.json
└── public/           # static assets (logos, images)

By default, Holocron looks for MDX files relative to the project root. You can change this with the pagesDir option. See Pages directory for details.