Sveltekitbook
Runtime helpers for SvelteKit books scaffolded by create-sveltekitbook. Gestures, inline markdown, spectrum palette, Giscus comments.
sveltekitbook
Runtime helpers for SvelteKit books scaffolded with
create-sveltekitbook.
See it in use: sveltekitbook-tour — a sample book that explains this format. (source)
Sibling project: create-sveltekitslides —
the slide-deck scaffolder. Same scroll model and outline.js philosophy,
different chrome (presentation timer, pace bar, QR per slide, /presenter
popout, optional phone↔laptop sync).
Small on purpose. The bulk of each book (routes, cover, contents, per-page layout) is scaffolded into the book as editable starter files, not hidden behind a component API. This package only holds the parts that are truly shared and stable:
| Export | What it is |
|---|---|
sveltekitbook/gestures |
createPager({ onNext, onPrev, setOffset }) — wheel + touch-drag → page nav. |
sveltekitbook/md |
md(text, { glossary, glossaryBase }) — inline `code`, **bold**, *em*, [text](url), [[term]] → glossary link. Also exports mdBlock(text, opts) — paragraph-aware variant that splits on blank lines and emits <p> per paragraph. Render inside a <div> wrapper, never <p>. |
sveltekitbook/palette |
makeSpectrum({ ramp, inverted }) → { paletteFor, styleFor, modeFor } for spectrum books. |
sveltekitbook/Giscus.svelte |
Giscus comments mounted by props (repo, repoId, category, categoryId, term, mode). |
sveltekitbook/PageMeta.svelte |
Drops Open Graph + Twitter Card tags into <svelte:head> so per-page URLs unfurl with a tldr in Slack/iMessage/Discord. Props: title, description, url, siteName, image, imageAlt, type, twitterCard. |
Consumed directly by projects generated via npm create sveltekitbook.
You usually don't install it by hand.
