sveltekit demo
← Demo home

Introduction

Docvia is a documentation framework built on a compiler architecture. It parses Markdown into an Intermediate Representation (IR), then renders framework-optimized output for Svelte, React, or any target.

How it works

Markdown → Parser → IR → Renderer → Framework Output
  1. Parse — Micromark parses your .md files into an AST
  2. Transform — The IR layer converts the AST into framework-agnostic nodes
  3. Render — A renderer adapter (Svelte, React) produces serialized output
  4. Deliver — SvelteKit renders the output with full SSR support

All heavy work happens at build time. At runtime, your pages are pre-compiled JSON trees — no markdown parsing, no syntax highlighting overhead.

Why Docvia

  • Type-safe — Generated TypeScript types for routes and frontmatter
  • Framework-native — SvelteKit SSR, Svelte 5 runes, not framework-agnostic wrappers
  • Build-time compilation — Shiki syntax highlighting, IR transforms, and rendering happen once
  • Interactive islands — Embed Svelte components in Markdown with selective hydration
  • Zero client JS by default — Only interactive components ship JavaScript

Quick start

npm install -D @docvia/cli @docvia/plugin-vite @docvia/plugin-shiki
npm install @docvia/renderer-svelte @docvia/source

npx docvia init

docvia init scaffolds a docvia.config.ts and sample docs. Add the docvia() Vite plugin — see Getting Started — then load and render pages in your SvelteKit routes:

import { docs } from "virtual:docvia/source";

const page = await docs.getPage(["getting-started"]);

Next steps