Overview

Brief is a next-gen documentation framework crafted beautifully for humans and optimized for agents.

Highlights#

Beautiful UI themes.
CLI-based docs management.
Linter with over 50 rules to ensure all SEO and AEO checkboxes are ticked.
Enabled-by-default agent features like MCP, /llms.txt, and .md pages.
Versioning & internationalization as first class features.
Automatic redirect management.
Broken link detection.

How it works#

The brief CLI uses the Brief compiler to manage your docs' pages, tabs, translations, and versions.

The compiler also lints for SEO improvements like broken link corrections, repeated page titles, and under-optimized header hierarchy.

The frontend uses the compiler output to generate all your human-facing pages, agent-facing routes, and MCP tools.

Component Showcase#

Brief supports a wide variety of components. These are some of the flashier ones.

Code#

Syntax-highlighted code block and folder explorer.

Line numbersHighlights & diffs

Files

web/src/main.ts

import { greet } from "./greet"
import "./styles.css"

const target = document.querySelector("#app")
if (target) {
  target.textContent = greet("reader")
}

api/app/main.py

from fastapi import FastAPI
from .routes import router

app = FastAPI(title="Brief demo")
app.include_router(router)

@app.get("/health")
def health():
    return {"status": "ready"}