shared-goals/text-forge
Build/publish a Markdown chapter collection into multiple formats (MkDocs site, EPUB, combined markdown)
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| mkdocs_config | Path to mkdocs.yml | no | mkdocs.yml |
| docs_dir | MkDocs docs_dir (where markdown lives) | no | text |
| site_dir | Output directory for MkDocs site | no | public |
| build_dir | Build artifacts directory | no | build |
| strict | Run mkdocs build with --strict | no | true |
| copy_artifacts_into_docs | Copy EPUB + combined markdown into site_dir root after mkdocs build | no | true |
| cover_image | Optional cover image path (relative to content repo) | no | "" |
| ensure_full_git_history | Fetch full git history if checkout is shallow (improves revision date accuracy) | no | true |
| use_github_token_for_committers | Export github.token as MKDOCS_GIT_COMMITTERS_APIKEY for mkdocs-git-committers-plugin-2 | no | true |
| committers_token | Optional token to use for mkdocs-git-committers-plugin-2 (overrides github.token) | no | "" |
Outputs
| name | description |
|---|---|
| combined_md | Path to combined markdown output |
| pandoc_md | Path to pandoc-normalized markdown output |
| epub | Path to generated EPUB |