Create aggregated, Swagger-like documentation from your .mmt files. A doc file lists folders and files to scan, then renders a searchable HTML page in the…
Markdown (no JavaScript)
# Doc Create aggregated, Swagger-like documentation from your `.mmt` files. A `doc` file lists folders and files to scan, then renders a searchable HTML page in the editor UI. Open a doc file in VS Code to preview HTML or Markdown on the right. Click {{btn:edit:Edit Doc}} to edit sources, services, and metadata — see [Edit Doc](./edit.md).  Supported: - Sources: folders and/or individual `.mmt` files - Services: optional groupings (each with its own sources) - Auto-rendered HTML with sticky header (logo, title, search) and expandable API boxes --- ## Elements The `doc` type is intentionally small: - `title:` page title shown in the header - `description:` introductory text shown below the title in the rendered output - logo: path or URL to a logo image, displayed in the HTML header - `import:` optional JSON/YAML/CSV data imports referenced with `${alias.path}` - `sources:` array of folders and/or `.mmt` files to include - services: optional array of groups with `name`, `description?`, and `sources` Data imports can be used to share doc metadata or source lists. See [Data imports](../../features/data-imports.md). The editor’s Doc view: - Renders a sticky header with logo (if configured), title, and a search box - Lets you filter API boxes by typing in the search field (matches text in the box) - Each API row is expandable; details include URL, inputs, headers, cookies, body, outputs, and examples when present - Example blocks may include their own inputs and outputs when provided --- ## Complete example ```yaml type: doc title: Platform APIs sources: - ./apis services: - name: Users description: Core user CRUD and profile sources: - ./services/users - name: Orders description: Order placement, tracking, and status sources: - ./services/orders ``` Open this file in VS Code; the Doc view renders an interactive, searchable page of APIs. --- ## Doc elements - [Quick start](./quick-start.md) · [Edit Doc](./edit.md) · [Generate docs](../../tasks/generate-docs.md) - [Environment](./environment.md) · [Annotations](./annotations.md) · [Input and output documentation](../input-output-docs.md) · [Markdown](./markdown.md) · [CLI](./cli.md) · [Reference](./reference.md)
For AI agents · llms.txt · Home