# Geistdocs Package Docs These docs are bundled with `@vercel/geistdocs` 2.9.3 so agents can understand the installed package without web access. They are generated from `apps/template/content/docs` during the package build. ## How to use these files - Read `docs/sitemap.md` first to identify focused pages. - Read `docs/pages/*.md` for task-specific guidance. - Read `docs/llms.txt` when you need the complete Geistdocs documentation context. - Use `docs/manifest.json` when you need structured metadata for every bundled page. - Do not edit package internals in `node_modules/@vercel/geistdocs`; configure local adapters in the generated app instead. ## Important package surfaces - `@vercel/geistdocs/config` for `defineConfig` and config types. - `@vercel/geistdocs/source` for Fumadocs source adapters. - `@vercel/geistdocs/pages/docs` for docs page rendering. - `@vercel/geistdocs/routes/*` for search, chat, Markdown, sitemap, and agent-readiness routes. - `@vercel/geistdocs/proxy` for markdown negotiation, AI-agent rewrites, and i18n fallback. - `@vercel/geistdocs/source-config` for source-config-safe Fumadocs schemas and plugins. ## Bundled pages - [Overview](pages/index.md): Geistdocs is a packaged documentation system for creating Next.js and Fumadocs sites with shared runtime features. - [Getting Started](pages/getting-started.md): Create a Geistdocs project, run it locally, and edit your first documentation page. - [Environment Variables](pages/env.md): Environment variables required by Geistdocs for AI chat, Mixedbread retrieval, proxy mode, eve agent session cookies, and production URL configuration. - [Deploy to Vercel](pages/deployment.md): Deploy a Geistdocs site to Vercel with the required project settings and environment variables. - [Migrate to Geistdocs](pages/migration.md): Move an existing documentation site to @vercel/geistdocs while keeping local content, routing, middleware behavior, and AI-readable surfaces intact. - [Choose a Geistdocs package](pages/packages.md): Use the public package by default and the private package only where restricted Vercel npm dependencies are already available. - [Configuration](pages/configuration.md): Configure site metadata, navigation, AI features, page actions, translations, and local adapters. - [MDX Components](pages/syntax.md): MDX component and authoring reference covering tabs, text formatting, code blocks, line highlighting, and Mermaid diagrams. - [Geistdocs Provider](pages/provider.md): The root provider component that wraps your application to handle toast notifications, search, and analytics. - [Versioned docs](pages/versioned-docs.md): Use createVersionedSources to configure stable, pre-release, or host-based documentation versions. - [Proxy and markdown routes](pages/proxy.md): Configure createProxy with generated route discovery, request hooks, markdown mappings, and a static Next.js matcher. - [Add a changelog](pages/changelog.md): Connect collection or paged ChangelogSource data to five thin HTML, Markdown, and JSON adapters, preserving existing docs mappings. - [.md Extension](pages/md.md): Access any documentation page as raw Markdown by appending .md or .mdx to the URL for AI tool consumption. - [Agent readiness](pages/agent-readiness.md): Generate /agents.md and /.well-known/mcp.json from Geistdocs config so agents can find docs, Markdown surfaces, API specs, and MCP endpoints. - [Ask AI](pages/ask-ai.md): An AI-powered chat assistant with context-aware search, persistent history, and suggested prompts for your documentation. - [Badge](pages/components/badge.md): Import Badge from the package component subpath for labels outside authored MDX. - [Button](pages/components/button.md): Use the provider-backed Button in application UI or directly in MDX. - [Callout](pages/components/callout.md): Use Callout directly or compose its container, title, and description primitives. - [Code Block](pages/components/code-block.md): Use CodeBlock when code is highlighted or assembled outside authored Markdown fences. - [Collapsible](pages/components/collapsible.md): Compose Collapsible, CollapsibleTrigger, and CollapsibleContent in custom React UI. - [Command Prompt](pages/components/command-prompt.md): Compose the CommandPrompt primitives for application-owned install and setup commands. - [Components](pages/components/index.md): Browse every component subpath exported by Geistdocs. These components can be imported into application code without relying on the default MDX component map. - [Configure sidebar navigation](pages/guides/nested-navigation.md): Configure sidebar order, section labels, folder landing pages, and deeply nested page trees with meta.json files. - [Copy Prompt](pages/components/copy-prompt.md): Use CopyPrompt for reusable instructions that readers can send to an AI assistant. - [Details](pages/components/details.md): Compose Details and Summary for accessible browser-native disclosures. - [Dialog](pages/components/dialog.md): Compose Dialog primitives for modal search, chat, forms, and confirmations. - [Dropdown Menu](pages/components/dropdown-menu.md): Compose DropdownMenu primitives for application-owned menus outside MDX. - [Edit on GitHub](pages/edit-on-github.md): A direct link on every documentation page that lets readers propose changes through GitHub pull requests. - [Feedback](pages/feedback.md): An interactive feedback widget that collects user sentiment and creates structured GitHub Issues automatically. - [Image](pages/components/image.md): Use the Geistdocs Image wrapper for documentation-aware Next.js images. - [Improve Ask AI answers with Mixedbread](pages/mixedbread-retrieval.md): Provision a Mixedbread Store for one Geistdocs consumer site, enable semantic retrieval, and sync documentation during production builds. - [Input](pages/components/input.md): Use Input for text entry in custom documentation and application interfaces. - [Internationalization](pages/internationalization.md): Serve documentation in multiple languages with automatic translation via the Geistdocs CLI and Fumadocs routing. - [llms.txt](pages/llms-txt.md): A single endpoint that returns all documentation as plain Markdown text following the llms.txt standard. - [Mermaid](pages/components/mermaid.md): Use Mermaid directly when diagram source is assembled outside an MDX Mermaid fence. - [Native Link](pages/components/link.md): Use NativeDocsLink where Next.js client navigation is not appropriate. - [Navigation Menu](pages/components/navigation-menu.md): Compose NavigationMenu primitives for custom product and documentation navigation. - [Open in Chat](pages/open-in-chat.md): Transfer documentation context to AI chat platforms like ChatGPT, Claude, Cursor, and v0 with a single click. - [Popover](pages/components/popover.md): Compose Popover, PopoverTrigger, and PopoverContent outside MDX. - [RSS](pages/rss.md): An automatically generated RSS 2.0 feed that keeps users informed when documentation is published or updated. - [Scroll Area](pages/components/scroll-area.md): Compose ScrollArea and ScrollBar for constrained custom interfaces. - [Steps](pages/components/steps.md): Write consecutive headings that start with a number, such as "### 1. Install", to render a numbered step list. The Steps and Step components cover cases where a heading must be wrapped in another component. - [Table of contents](pages/table-of-contents.md): Geistdocs builds the "On this page" outline from your headings, indents sub-headings under their parent, and tracks the active section along a straight vertical guide rail. - [Tabs](pages/components/tabs.md): Use Tabs for navigation-only controls or TabsWithChildren and TabContent for mounted content panels. - [Theme Switcher](pages/components/theme-switcher.md): Use ThemeSwitcher in custom navigation, settings, and footer UI. - [Toast](pages/components/toast.md): Trigger provider-backed success, warning, and error notifications. - [Toggle](pages/components/toggle.md): Toggle is the provider-backed replacement for the former Switch export. - [Tooltip](pages/components/tooltip.md): Wrap controls with provider-backed Tooltip content outside MDX. - [Video](pages/components/video.md): Use Video for embedded video sources inside React UI or authored MDX. - [WebMCP](pages/webmcp.md): Expose documentation search, page reading, and Ask AI to browser agents.