Agent-readable docs index: /llms.txt. Download /docs.zip to grep all markdown files locally.

Base Path

If you want to serve your docs under a subpath (e.g. https://example.com/docs/), configure Vite's base option:
// vite.config.ts
import { defineConfig } from 'vite'
import { holocron } from '@holocron.so/vite'

export default defineConfig({
  base: '/docs/',
  plugins: [holocron()],
})

What it affects

  • Holocron registers base-prefixed page routes (e.g. /docs/quickstart) and currently also keeps root routes available
  • Static assets load from /docs/assets/...
  • AI routes are available at /docs/llms.txt and /docs/docs.zip; root /llms.txt and /docs.zip remain available too
  • Internal links and navigation are base-aware
  • The sitemap uses the base path in URLs

Reverse proxy setup

When using a base path, your reverse proxy must forward requests under /docs/ to the Holocron server:
location /docs/ {
    proxy_pass http://localhost:3000/docs/;
}

Custom entry with base path

If using a custom entry, Holocron's docs routes are base-aware. Your custom routes are controlled by your own Spiceflow app, so prefix them explicitly if they should also live under the same base path.
Powered byHolocron