Skip to content

AI-friendly output

Docfuse generates machine-readable files together with the site. The build does not call an external model and does not require an API key.

Generated files

      • llms.txt
      • llms-full.txt
        • manifest.json
        • index.md
        • pages.json
        • summaries.json
        • code-examples.json
              • 0001.jsonl
          • index.html
          • index.md
            • index.html
            • index.md
table
llms.txtTitles and site URLs selected by ai.versionsCrawler entry point
llms-full.txtFull Markdown while within budget; otherwise a pointer to the shard manifestCompatible entry point for small and large sites
ai/manifest.jsonSchema version, budgets, totals, partitions, shard paths, sizes, record counts, and SHA-256 fingerprintsStable discovery for complete corpora
ai/content/{version}/{locale}/*.jsonlSize-bounded content records with part / partsStreaming RAG ingestion without a monolithic download
ai/index.mdTitle-to-Markdown-source listGeneric Markdown index
ai/pages.jsonRoutes, locales, heading trees, tags, owners, frontmatter, and timestampsMetadata before RAG chunking
ai/summaries.jsonDeterministic page summariesResult previews and route filtering
ai/code-examples.jsonRoutes, locales, and fenced codeCode-example search
Per-page index.mdMarkdown or MDX source used by the buildPage-level retrieval and citation

Summary generation

Docfuse makes no network request for summaries. It uses, in order:

  1. Frontmatter description.
  2. The first body paragraph that is not a heading or code block.
  3. An empty string when no suitable paragraph exists.

Write a precise description for every public page instead of a promotional slogan.

Inclusion rules

  • Published pages in the current version are included by default.
  • Historical versions are excluded to avoid multiple outdated answers for the same topic.
  • Pages with status: draft are not built.
  • ai: false excludes a page.
  • tags and owner are preserved in pages.json.
yaml
---title: Internal incident responsedescription: Incident steps for the private networkai: false---

Configuration

ts
export default {  ai: {    llmsTxt: true,    llmsFullTxt: true,    markdownIndex: true,    pageSummaries: true,    codeExamples: true,    chunkSizeBytes: 262144,    llmsFullMaxBytes: 10485760,    llmsFullOverflow: 'manifest',    versions: 'current'  }}

pages.json and the versioned shard manifest are always generated. The other files follow their switches. A content record never exceeds chunkSizeBytes; an unusually large page is split on Unicode code-point boundaries and reconstructed in part order. When the full corpus exceeds llmsFullMaxBytes, manifest keeps llms-full.txt small and points to the lossless shards, while error fails the atomic build. versions: 'all' includes historical snapshots in isolated version/locale partitions; current remains the safer default.

Private documentation

AI files and neighboring Markdown sources are static site output. An access layer for a private site must protect /*.md, /ai/*, /llms*.txt, and search indexes as well as HTML pages.