eric/distributor
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 7 Wiki Activity

Add Markdown HTML publication

Browse Source
This commit is contained in:
Eric Rakestraw
2026-05-31 02:28:48 +00:00
parent e296361042
commit 5408f14195
21 changed files with 628 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/config.md
View File

@@ -10,7 +10,7 @@ If `--config` is omitted during run, the built-in default path is:
/usr/local/etc/distributor/config.yml
```
The current implementation supports local-to-local source-file publication. Remote backends and HTML publication are not implemented yet.
The current implementation supports local-to-local publication of source files, generated HTML files, or both. Remote backends are not implemented yet.
## Minimal config
@@ -74,7 +74,7 @@ Backends:
Destination policy:
- `publish.source`: publish source artifacts.
- `publish.html`: publish generated HTML artifacts.
- `publish.html`: publish generated HTML artifacts from Markdown source files.
- `transfer.on_destination_same`: `skip` or `fail`, defaults to `skip`.
- `transfer.on_destination_older`: `replace` or `fail`, defaults to `replace`.
- `transfer.on_destination_newer`: `skip` or `fail`, defaults to `skip`.
@@ -82,6 +82,8 @@ Destination policy:
When `publish.html` is true, `transform.markdown_to_html.enabled: true` and `transform.markdown_to_html.mode: sidecar` are required.
Markdown-to-HTML sidecar generation writes `report.html` for `report.md` and does not mutate the source bundle.
## Secrets
Do not put literal secrets in config files. S3 credentials may refer to environment variable names with: