@charmland/gem-vite
v0.1.1
Published
The Vite plugin that turns a markdown directory into a prerendered docs site.
Readme
@charmland/gem-vite
Build prerendered documentation sites from Markdown with Vite and Elm-backed rendering.
Install
npm install --save-dev @charmland/gem-vite @charmland/gem viteThe Vite integration requires Node ^22.22.2 || ^24.15.0 || >=26.0.0, matching the prerenderer's jsdom engine floor.
The default integration uses @charmland/gem. It is an optional peer only for projects supplying both a fully custom entry and prerender theme.
Usage
import { defineConfig } from "vite";
import { gem } from "@charmland/gem-vite";
export default defineConfig({
plugins: [gem()],
});Add content/index.md, then run vite dev or vite build. The package's public entrypoint is @charmland/gem-vite, which exports the gem plugin and GemOptions.
The default setup uses Gem's prebuilt theme and does not need the Elm compiler. Install and use Elm only when customizing and recompiling Gem's Elm sources. See the Gem documentation for customization details.
Build performance
generateBundle runs sequentially: it renders and emits the OG covers first, then prerenders every page in source order and writes its .md and HTML. Prerendering boots the real Elm theme in jsdom, which is CPU-bound, and the build prints one [gem] build timings line separating covers, prerendering, the 404 page and the total. Covers use Takumi's native renderer (@takumi-rs/core), loaded lazily and drawing each PNG in a single native pass with no headless browser or separate SVG rasterization step.
