Skip to content
Blode.md

AI agents: fetch the documentation index at llms.txt. Markdown versions are available by appending .md to any page URL, including this page's markdown.

SEO and sitemaps

Search engine optimization, sitemaps, and AI-friendly exports.

Blode.md automatically generates the files search engines and AI crawlers need to discover and index your documentation. You get sensible defaults out of the box, with options to customize behavior per page.

Auto-generated files

Every deployed site includes these files at their standard paths:

FieldTypeDescriptionRequired
/robots.txtAuto-generatedStandard robots file. Allows all crawlers by default.Yes
/sitemap.xmlAuto-generatedXML sitemap listing all public pages with last-modified dates.Yes
/llms.txtAuto-generatedPlaintext summary of your documentation for AI crawlers.Yes
/llms-full.txtAuto-generatedComplete documentation content in plaintext format.Yes
/{page}.mdAuto-generatedIndividual pages in Markdown format for programmatic access.Yes

Append .md to any page URL to get its Markdown export. For example, /docs/quickstart becomes /docs/quickstart.md.

Public URL

By default your site publishes at its Blode.md subdomain, or at your custom domain once you add one. If you put a proxy in front — serving docs from yourdomain.com/docs while we see acme.blode.md — declare where the site actually lives:

{
  "seo": {
    "siteUrl": "https://yourdomain.com/docs"
  }
}

Include the path prefix if you serve under one. Canonical tags, og:url, JSON-LD, the sitemap, llms.txt and the .md alternates are all built from this one value, so they stay consistent no matter which URL a request arrives on.

Indexing mode

Control how search engines index your site with the seo.indexing option in docs.json:

{
  "seo": {
    "indexing": "all"
  }
}
ValueBehavior
"all"All pages are indexed. Page-level noindex frontmatter is ignored.
"default"Pages with noindex: true in frontmatter are excluded from indexing.

Page-level noindex

To exclude a specific page from search engine indexing, add noindex: true to its frontmatter:

---
title: Internal notes
noindex: true
---

This page will not appear in search engine results.

Last-modified timestamps

Enable last-modified metadata with the metadata.timestamp option. This adds <meta> tags and updates your sitemap entries with accurate dates:

{
  "metadata": {
    "timestamp": true
  }
}