generated from coulomb/repo-seed
33 lines
1.5 KiB
Markdown
33 lines
1.5 KiB
Markdown
# Quarkdown Profile Matrix
|
|
|
|
The adapter maps Markitect render profiles onto Quarkdown document/output
|
|
intent. The CLI command is still configurable because Quarkdown distribution
|
|
and command spelling may change across 2.x releases.
|
|
|
|
| Markitect profile | Quarkdown document type | Output format | Artifact media type | Extension |
|
|
| --- | --- | --- | --- | --- |
|
|
| `plain` | `plain` | `txt` | `text/plain` | `.txt` |
|
|
| `docs` | `docs` | `html` | `text/html` | `.html` |
|
|
| `slides` | `slides` | `html` | `text/html` | `.html` |
|
|
| `paged` | `paged` | `pdf` | `application/pdf` | `.pdf` |
|
|
| `static-site` | `docs` | `html` | `text/html` | `.html` |
|
|
| `pdf` | `paged` | `pdf` | `application/pdf` | `.pdf` |
|
|
|
|
PDF-oriented profiles require Quarkdown's PDF runtime path, including Java and
|
|
Node.js/npm/Puppeteer assumptions.
|
|
|
|
## Options
|
|
|
|
The adapter accepts these stable Markitect-facing options:
|
|
|
|
- `command`: Quarkdown command name or path, default `quarkdown`
|
|
- `workspace`: temporary working directory override
|
|
- `output_dir`: output directory, default `quarkdown-output`
|
|
- `artifact_stem`: expected artifact basename, default from source stem
|
|
- `permissions`: Quarkdown permission allow-list, default `project-read`
|
|
- `deny_network`: append a network deny flag, default `true`
|
|
- `dry_run`: return an execution-plan artifact without invoking Quarkdown
|
|
|
|
Renderer packages and automation may add extra options, but they should remain
|
|
under this adapter boundary rather than leaking into `markitect-tool`.
|