Overview

JAAD is an Astro integration that turns a folder of Markdown files into a documentation site. It provides navigation, search, theming and static output without requiring a sidebar or route configuration.

Create a documentation-only project:

npm create @jaamd/jaad@latest my-docs

pnpm create @jaamd/jaad@latest my-docs

yarn create @jaamd/jaad@latest my-docs

bun create @jaamd/jaad@latest my-docs

Or add JAAD to a repository that already has documentation:

npm create @jaamd/jaad@latest -- --here

pnpm create @jaamd/jaad@latest --here

yarn create @jaamd/jaad@latest --here

bun create @jaamd/jaad@latest --here

Markdown files live in docs/. Numeric prefixes control their order and are removed from generated URLs:

docs/
  01-introduction.md
  02-guides/
    01-setup.md

Continue with Installation, learn how to create pages, or open the configuration reference.