mkdocs-llm-context 0.1.0

Bundle your MkDocs site into a single file for LLM or agent context.

mkdocs-llm-context

Bundle your MkDocs site into a single file for LLM or agent context.

Installation

pip install mkdocs-llm-context

Usage

Add the plugin to your mkdocs.yml:

plugins:
  - llm-context

Configuration

plugins:
  - llm-context:
      format: json        # "json" (default) or "txt"
      output: llm-context.json  # default derives from format
      exclude:
        - changelog/
        - api/reference/*

Option	Default	Description
format	json	Output format: json (list of {url, title, content}) or txt (sections separated by ---)
output	llm-context.{format}	Filename written to the site directory
exclude	[]	Glob patterns matched against page.url — matching pages are omitted

After mkdocs build, the file appears in site/ and can be used as context for an LLM or agent.

Development

git clone https://github.com/agibson22/mkdocs-llm-context
cd mkdocs-llm-context
python -m venv .venv && source .venv/bin/activate
make install

make test   # run tests
make lint   # run ruff
make build  # build the wheel

See CONTRIBUTING.md for more details.