# Markbook

> **Note:** This is a summary overview using the LLMs.txt format (https://llmstxt.org/). Each section links to its full documentation file in plain text format.

A library that renders markdown into HTML, with a React adapter (Vue and web components planned) — so it can also do component-library showcases like Storybook.

- [Guides/Adding component stories](./llms/guides/adding-stories.txt): Mount React component examples inside your markdown pages.
- [Guides/Agent skills](./llms/guides/agent-skills.txt): Markbook ships first-class agent skills — scaffold, generate, theme, and bundle from inside Claude Code, Codex, OpenCode, Cursor, or any agent CLI that auto-discovers skills.
- [Guides/Custom directives](./llms/guides/custom-directives.txt): Extend Markbook with your own :::name directives — youtube embeds, callouts, mermaid diagrams, anything.
- [Guides/Customization](./llms/guides/customization.txt): Four layers, each opt-in — from CSS variables to full HTML shell replacement.
- [Guides/Getting started](./llms/guides/getting-started.txt): Install Markbook, scaffold a project, write your first page, run the dev server.
- [Guides/Search and SEO](./llms/guides/search-and-seo.txt): Pagefind, canonical URLs, Open Graph, Twitter Cards, sitemap.xml, robots.txt, llms.txt — all built in.
- [Markbook](./llms/index.txt): Agent-first, markdown-first. A static-site engine that ships with first-class agent skills for setup, theming, and bundling — plus a React adapter for component stories when you need them.
- [Reference/CLI reference](./llms/reference/cli.txt): Every command, every flag.
- [Reference/Configuration reference](./llms/reference/config.txt): Every field of MarkbookConfig, with defaults and examples.
- [Reference/Markdown directives](./llms/reference/directives.txt): The custom :::directives Markbook recognizes — built-in (story, stories, props) and user-registered.
- [Reference/Frontmatter reference](./llms/reference/frontmatter.txt): Per-page YAML fields Markbook recognizes in the frontmatter block.
- [Reference/Layout placeholders](./llms/reference/placeholders.txt): Every {{ }} placeholder Markbook recognizes in HTML layouts.
- [Reference/Skills reference](./llms/reference/skills.txt): Every flag of every shipped agent skill. Use this when writing an AGENTS.md / CLAUDE.md, or when you need the exact invocation.