ferax564/Noma artifact and proof

Validate, render, or proof a .noma file or book manifest with the Noma CLI.

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Activelast commit Jun 13, 2026
License
MIT

Pinned Snippet

workflow.ymlSHA-pinned
uses: ferax564/noma@4d86aa046d58561e382034286c3c1e6da96154eb # v0.15.0

tags can be moved; commit SHAs can't. why a SHA?

namedescriptionrequireddefault
modeWorkflow mode: render or proof.norender
inputPath to a .noma source file or book manifest.yes
outputOutput file path, or directory path when rendering --to site.nonoma-artifact.html
toRender target: html, llm, json, noma, markdown, md, site, pdf, or docx.nohtml
cli-packagenpm package spec to install. Defaults to this action checkout.no""
cli-versionDeprecated npm version range for @ferax564/noma-cli; ignored when cli-package is set.no""
node-versionNode.js version used to run the CLI.no20
checkRun noma check before rendering.notrue
strictUse strict HTML rendering; blocks escape hatches and external CDN runtimes. Defaults to true so CI-rendered artifacts are inert; set to "false" to allow ::html/::svg/::script and CDN-backed diagram runtimes.notrue
themeHTML theme name.nodefault
mathOptional math mode override: katex or none.no""
stale-daysOptional stale-citation window for the validation step.no""
profileOptional comma- or space-separated validator profiles to apply during validation/proof.no""
ignore-ruleOptional comma- or space-separated validator rules to ignore during validation.no""
opInline patch op JSON for proof mode.no""
opsPath to a patch ops JSON file for proof mode.no""
proof-outputHTML proof artifact path when mode=proof.nonoma-proof.html
proof-summary-outputMarkdown proof summary path when mode=proof.nonoma-proof.md
comment-prPost the Markdown proof summary as a pull request comment when mode=proof.nofalse
github-tokenGitHub token used for pull request proof comments.no""
upload-artifactUpload the rendered output as a GitHub Actions artifact.notrue
artifact-nameArtifact name when upload-artifact is true.nonoma-render
namedescription
outputRendered output path.
proof-outputProof HTML output path.
proof-summaryProof Markdown summary path.
proof-exit-codeExit code returned by the proof command.