# Blode.md
> Blode.md: git-native docs, published on merge. Write MDX in the repo, review it in the pull request, and the merge publishes the site.

Sitemap: https://blode.md/docs/sitemap.xml
Full content: https://blode.md/docs/llms-full.txt
Skills: https://blode.md/docs/.well-known/skills/index.json

## Segments
- [Getting started](https://blode.md/docs/llms/getting-started.txt)
- [Writing content](https://blode.md/docs/llms/writing-content.txt)
- [Configuration](https://blode.md/docs/llms/configuration.txt)
- [Deployment](https://blode.md/docs/llms/deployment.txt)
- [Features](https://blode.md/docs/llms/features.txt)
- [Guides](https://blode.md/docs/llms/guides.txt)
- [API](https://blode.md/docs/llms/api.txt)
- [Content](https://blode.md/docs/llms/content.txt)
- [Code](https://blode.md/docs/llms/code.txt)
- [Layout](https://blode.md/docs/llms/layout.txt)
- [Data display](https://blode.md/docs/llms/data-display.txt)
- [CLI](https://blode.md/docs/llms/cli.txt)

## Docs
- [REST API overview](https://blode.md/docs/api/overview.md): Use the Blode.md REST API for programmatic access to projects, deployments, and domains when you need custom tooling beyond the CLI workflows.
- [blodemd analytics](https://blode.md/docs/cli/analytics.md): Use blodemd analytics to read and write PostHog project keys for a tenant, script rollouts in CI, and keep analytics config in your docs repo.
- [blodemd dev](https://blode.md/docs/cli/dev.md): Start a local Blode.md preview server with hot reload so you can write MDX and see production-quality docs update as you save.
- [blodemd login](https://blode.md/docs/cli/login.md): Authenticate the Blode.md CLI with GitHub in your browser, store a local OAuth session, and unlock deploy commands like blodemd push.
- [blodemd logout](https://blode.md/docs/cli/logout.md): Remove the Blode.md CLI credentials file from your machine so the local OAuth session ends and future deploys require login again.
- [blodemd new](https://blode.md/docs/cli/new.md): Scaffold a new Blode.md docs site with docs.json and an index.mdx starter page, either in the current folder or a docs subdirectory.
- [CLI overview](https://blode.md/docs/cli/overview.md): Install the blodemd CLI, authenticate with GitHub, and use login, new, validate, dev, push, and analytics commands from your terminal.
- [blodemd push](https://blode.md/docs/cli/push.md): Deploy your local MDX docs to Blode.md with blodemd push, using a browser session locally or a project deploy key in CI pipelines.
- [blodemd validate](https://blode.md/docs/cli/validate.md): Validate docs.json and your docs directory before deploy so the CLI catches schema errors, missing files, and common config mistakes early.
- [blodemd whoami](https://blode.md/docs/cli/whoami.md): Print the email for the active Blode.md CLI session, refresh stored OAuth credentials when needed, and confirm you are logged in before deploying.
- [Accordion](https://blode.md/docs/components/accordion.md): Use Accordion and AccordionGroup to hide FAQs and long details behind toggles, keeping docs scannable while still exposing deeper answers on demand.
- [Callout](https://blode.md/docs/components/callout.md): Highlight tips, warnings, and critical notes with Callout boxes so readers notice important guidance without breaking the flow of your docs.
- [Card](https://blode.md/docs/components/card.md): Present features, links, and related pages in Card containers, alone or in grids, with optional icons and hrefs for clearer docs navigation.
- [Code group](https://blode.md/docs/components/code-group.md): Show related code samples in a CodeGroup with tabbed navigation so readers can switch languages, package managers, or tools in one place.
- [Columns](https://blode.md/docs/components/columns.md): Arrange Cards and other content in responsive Columns that stack on small screens and expand into multi-column layouts on larger viewports.
- [Expandable](https://blode.md/docs/components/expandable.md): Hide nested properties, optional fields, and advanced options behind Expandable sections so reference docs stay readable without losing detail.
- [Frame](https://blode.md/docs/components/frame.md): Wrap screenshots, diagrams, and media in a Frame with an optional caption to separate visuals from body copy in your documentation pages.
- [Installer](https://blode.md/docs/components/installer.md): Display a copyable package install command with the Installer component, including a styled default command generated from a package path.
- [Steps](https://blode.md/docs/components/steps.md): Guide readers through numbered instructions with Steps and Step components so setup, install, and deploy workflows stay clear and sequential.
- [Tabs](https://blode.md/docs/components/tabs.md): Organize alternate content into Tabs and Tab panels so readers can switch between related options without leaving the documentation page.
- [Tree](https://blode.md/docs/components/tree.md): Visualize file and folder hierarchies with the Tree component, including collapsible folders for interactive project structure examples.
- [Type table](https://blode.md/docs/components/type-table.md): Document props, API fields, and config shapes with TypeTable so readers can scan types, requirements, defaults, and descriptions in one place.
- [docs.json reference](https://blode.md/docs/configuration/docs-json.md): Reference every supported docs.json field for navigation, branding, collections, OpenAPI, analytics, and deployment settings in your Blode.md project.
- [Navigation](https://blode.md/docs/configuration/navigation.md): Configure sidebar groups, tabs, nested pages, hidden routes, and page ordering in docs.json to control how readers browse your documentation site.
- [Appearance and branding](https://blode.md/docs/configuration/theming.md): Configure logo, favicon, and appearance settings in docs.json, including separate light and dark assets and supported branding options for your site.
- [Code blocks](https://blode.md/docs/content/code-blocks.md): Use fenced code blocks with Shiki syntax highlighting, optional titles for filenames, and CodeGroup tabs for multi-file or multi-language examples.
- [Frontmatter](https://blode.md/docs/content/frontmatter.md): Reference every YAML frontmatter field for Blode.md pages, including title, description, sidebarTitle, icon, and SEO options with examples.
- [MDX basics](https://blode.md/docs/content/mdx-basics.md): Learn how to write Blode.md documentation with standard Markdown, GFM syntax, and built-in JSX components that need no import statements.
- [Continuous deployment](https://blode.md/docs/deployment/ci.md): Deploy docs automatically with the GitHub App on every push, or run blodemd push from GitHub Actions and other CI providers using a deploy key.
- [Deploying with push](https://blode.md/docs/deployment/push.md): Deploy your MDX docs to Blode.md with blodemd push, including project slug resolution, API key auth, directory options, and what happens during upload.
- [PostHog analytics](https://blode.md/docs/features/analytics.md): Connect your own PostHog project key in the dashboard to load analytics on every tenant docs page, with an optional EU host and no content wiring.
- [Content types](https://blode.md/docs/features/collections.md): Define collections in docs.json to publish blogs, courses, changelogs, and other content types alongside your main documentation with separate URLs.
- [Custom domains](https://blode.md/docs/features/custom-domains.md): Point a custom domain or subdomain at your Blode.md docs site, configure DNS with CNAME records, and add the domain in your project dashboard.
- [Local development](https://blode.md/docs/features/dev-server.md): Run blodemd dev to preview your documentation locally at localhost with hot reload, matching the deployed site as you edit MDX and docs.json.
- [OpenAPI integration](https://blode.md/docs/features/openapi.md): Add an OpenAPI spec to your content directory, configure api.openapi in docs.json, and generate API reference pages for every operation automatically.
- [Full-text search](https://blode.md/docs/features/search.md): Blode.md indexes titles, headings, and body text on deploy so visitors get built-in full-text search with keyboard shortcuts and no extra setup.
- [SEO and sitemaps](https://blode.md/docs/features/seo.md): Learn how Blode.md generates robots.txt, sitemaps, llms.txt exports, and per-page meta tags so search engines and AI crawlers can index your docs.
- [Migrate from Mintlify](https://blode.md/docs/guides/migrate-from-mintlify.md): Move a Mintlify docs repo to Blode.md. Copy the MDX, rewrite docs.json to the smaller schema, validate, preview, push, and keep your domain.
- [Proxy /docs through Cloudflare Workers](https://blode.md/docs/guides/proxy-cloudflare.md): Use a Cloudflare Worker to proxy /docs and /_docs paths on your domain to a Blode.md site, keeping marketing pages on your apex or subdomain.
- [Proxy /docs through Nginx](https://blode.md/docs/guides/proxy-nginx.md): Add Nginx location blocks to reverse-proxy /docs and /_docs on your domain to a Blode.md site while keeping the rest of your site on your server.
- [Proxy /docs through Vercel](https://blode.md/docs/guides/proxy-vercel.md): Host Blode.md docs at yourdomain.com/docs by adding rewrites for /docs and /_docs to your Next.js next.config.js on an existing Vercel marketing site.
- [How it works](https://blode.md/docs/how-it-works.md): See how local MDX, the blodemd CLI, Hono API, Vercel Blob storage, and the Next.js renderer work together when you push documentation.
- [Introduction](https://blode.md/docs/index.md): Blode.md: git-native docs, published on merge. Write MDX in the repo, review it in the pull request, and the merge publishes the site.
- [Quickstart](https://blode.md/docs/quickstart.md): Install the Blode.md CLI, authenticate with GitHub, scaffold a docs project with blodemd new, preview locally, and deploy live docs in minutes.