Files
markitect-quarkdown/README.md

45 lines
1.2 KiB
Markdown

# markitect-quarkdown
`markitect-quarkdown` provides the concrete Quarkdown render/export adapter for
Markitect. It keeps Quarkdown runtime assumptions out of `markitect-tool` while
still satisfying the Markitect render adapter contract.
## Scope
This repository owns:
- `render.quarkdown` adapter descriptor and entry point
- Markitect profile to Quarkdown profile mapping
- controlled Quarkdown CLI execution plans
- Quarkdown permission and runtime dependency mapping
- generated artifact validation and checksums
- open-reuse integration metadata
It does not reimplement Quarkdown, fork Quarkdown, or make core Markitect
responsible for renderer behavior.
## Development
Run tests from this checkout:
```bash
PYTHONPATH=src:/home/worsch/markitect-tool/src python3 -m pytest
```
The suite uses fake execution for adapter-boundary tests. A real Quarkdown
runtime smoke check skips when `quarkdown` is not installed.
## Entry Point
```toml
[project.entry-points."markitect_tool.render_export_adapters"]
quarkdown = "markitect_quarkdown.adapter:quarkdown_adapter_descriptor"
```
## Docs
- `docs/adapter-boundary.md`
- `docs/profile-matrix.md`
- `docs/permissions-and-runtime.md`
- `integration/quarkdown.integration.yaml`