Skip to content
Tasty Docs

Tasty Docs

Tasty Docs turns repository Markdown or the documentation shipped in an npm package into a complete static website. It combines Astro and Starlight with a Tasty/Glaze theme, strict content validation, and local Pagefind search.

Tasty Docs mark

Why Tasty Docs

  • Repository-native. Keep README.md, docs/, and local assets where they already live. Sources are transformed in memory and never rewritten.
  • Package-first. Generate a reproducible site from the files actually published to npm, without cloning the package repository or running its lifecycle scripts.
  • Strict by default. Broken links, missing assets, duplicate routes, invalid navigation, and unsafe paths fail the build with source locations.
  • Static first. Output is prerendered HTML and CSS suitable for GitHub Pages and any other static host.
  • Accessible color. A Glaze-derived theme preserves the authored brand color when it is readable and adjusts it when contrast requires it.

Choose a path

Create a documentation project from a published npm package:

Terminal window
npm create tasty-docs@latest my-package-docs -- --package your-package

Or add the complete integration to an Astro project:

Terminal window
npx astro add tasty-docs

Continue with Getting started, then learn how content sources become routes.

This site dogfoods Tasty Docs

The pages you are reading live in this repository’s root docs/ directory. The small Astro app under apps/reference points the integration and content loader at the repository root, validates this content, builds the site, and publishes the result to GitHub Pages. There is no copied documentation tree.

See Architecture for the package boundaries behind the site.