Generated Outputs

HTML, JSON, and agent-readable docs from the same OpenAPI input.

printing press renders three output families by default, with PDF on the way:

  • HTML documentation
  • JSON artifacts
  • LLM and markdown output
  • PDF (coming soon!)

Disable individual families when you do not need them:

ppress --no-html ./openapi.yaml ppress --no-json ./openapi.yaml ppress --no-llm ./openapi.yaml

At least one output family must remain enabled.

Single-spec root outputs

A single-spec build writes root files like:

api-docs/
  index.html
  index.json
  bundle.json
  manifest.json
  nav.json
  AGENTS.md
  llms.txt
  llms-full.txt
  llms-models.txt
  llms-operations.txt

Single-spec HTML outputs

HTML output includes:

api-docs/index.html
api-docs/operations/*.html
api-docs/models/index.html
api-docs/models/<type>/index.html
api-docs/models/<type>/*.html
api-docs/tags/*.html

When diagnostics mode is enabled, it can also include:

api-docs/diagnostics.html

Single-spec JSON outputs

JSON output includes the root bundle and per-page artifacts:

api-docs/bundle.json
api-docs/index.json
api-docs/operations/*.json
api-docs/models/<type>/*.json

These files are useful when another tool needs the same generated documentation model without scraping HTML.

Single-spec LLM outputs

LLM output includes root agent files and per-page markdown:

api-docs/AGENTS.md
api-docs/llms.txt
api-docs/llms-full.txt
api-docs/llms-models.txt
api-docs/llms-operations.txt
api-docs/operations/*.md
api-docs/models/<type>/*.md

Use these files when agents need concise API context or when docs need to be reviewed as markdown.

For the centralized agent workflow, see agentic AI.

API Catalog outputs

API Catalog builds add a service/version/spec hierarchy.

Root catalog outputs include:

api-docs/index.html
api-docs/index.json
api-docs/bundle.json
api-docs/manifest.json
api-docs/AGENTS.md
api-docs/llms.txt

Service and version LLM indexes include:

api-docs/services/<service>/llms.txt
api-docs/services/<service>/versions/<version>/llms.txt

Each spec entry gets a full generated doc tree:

api-docs/services/<service>/versions/<version>/specs/<entry>/index.html
api-docs/services/<service>/versions/<version>/specs/<entry>/bundle.json
api-docs/services/<service>/versions/<version>/specs/<entry>/AGENTS.md
api-docs/services/<service>/versions/<version>/specs/<entry>/llms.txt
api-docs/services/<service>/versions/<version>/specs/<entry>/operations/*.html
api-docs/services/<service>/versions/<version>/specs/<entry>/models/**/*.html

Static assets

Generated HTML output includes the runtime assets it needs under:

api-docs/static/

Default static mode and published mode write similar file trees. The main difference is how generated pages load their data:

  • static mode uses portable JavaScript data hydration for file://
  • published mode uses JSON hydration for static web servers