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.

Content types

Use collections to publish blogs, courses, products, and more alongside your docs.

Blode.md supports more than just documentation. You can publish blogs, courses, product pages, and other content types by defining collections in your configuration. Each collection has its own content directory, URL prefix, and navigation structure.

Define a collection

Collections use the SiteConfig format with a top-level collections array. Each collection is an object with its own id, type, and content root:

{
  "collections": [
    {
      "id": "docs",
      "type": "docs",
      "root": "content/docs",
      "slugPrefix": "/docs",
      "navigation": {
        "groups": [
          { "group": "Getting started", "pages": ["index", "quickstart"] }
        ]
      }
    },
    {
      "id": "blog",
      "type": "blog",
      "root": "content/blog",
      "slugPrefix": "/blog",
      "sort": "date:desc",
      "index": true
    }
  ]
}

Collection properties

FieldTypeDescriptionRequiredDefault
idstringUnique identifier for the collection.Yes
typestringThe content type. Determines which frontmatter fields are available and how pages are rendered.Yes
rootstringPath to the content directory for this collection, relative to the project root.Yes
slugPrefixstringURL prefix for all pages in this collection.Yes
navigationobjectNavigation structure for this collection. Same format as the top-level navigation.Yes
sortstringSort order for listing pages. Format: "field:direction" (e.g., "date:desc").Yes
indexbooleanWhether to auto-generate an index page listing all pages in the collection.Yesfalse

Available types

TypeUse case
siteGeneral-purpose website pages
docsDocumentation with sidebar navigation
blogBlog posts sorted by date
coursesOrdered learning content with progress
productsProduct pages with pricing and metadata
notesShort-form notes and snippets
formsForm pages with input fields
sheetsSpreadsheet-style data pages
slidesPresentation slides
todosTask lists and checklists

Type-specific frontmatter

Each collection type supports additional frontmatter fields beyond the standard title and description.

---
title: Launch week recap
description: Everything we shipped this week.
date: 2025-01-15
tags:
  - announcements
  - releases
author: Jane Smith
image: /images/launch-week.png
---

Full example

Here is a complete docs.json that defines both documentation and a blog:

{
  "name": "My Project",
  "slug": "my-project",
  "collections": [
    {
      "id": "docs",
      "type": "docs",
      "root": "content/docs",
      "slugPrefix": "/docs",
      "navigation": {
        "groups": [
          { "group": "Getting started", "pages": ["index", "quickstart"] },
          { "group": "Guides", "pages": ["guides/setup", "guides/deploy"] }
        ]
      }
    },
    {
      "id": "blog",
      "type": "blog",
      "root": "content/blog",
      "slugPrefix": "/blog",
      "sort": "date:desc",
      "index": true
    }
  ]
}