Code Proof release inspector / 0.1

Preflight for code-heavy manuals

Catch the PDF bugs Markdown hides.

Keep your renderer. Code Proof checks the artifact it leaves behind—code flow, page overflow, syntax color, and internal links—before readers find the damage.

Watch a proof run
  • Local onlyYour manual stays put
  • Renderer-neutralPandoc or your command
  • CI-readyJSON and stable exits
Two-color risograph collage of code pages inspected beneath a magnifying glass
Proof pull 001Two-ink inspection
Markdown sourceYour rendererCode ProofRelease PDF

The press check

One command. Evidence, not hope.

Code Proof compares the source contract with the fixed PDF and leaves a proof sheet your team can review in a browser.

  1. 01

    Render the real job

    Use the built-in Pandoc adapter, a custom command, or an already-built PDF. Arguments never pass through a shell.

  2. 02

    Inspect the fixed artifact

    Read PDF annotations, content streams, color operations, and painted text bounds. Match code lines back to their source fence.

  3. 03

    Hold or release

    Open the tactile HTML proof, archive JSON in CI, and use stable exit codes to stop a broken manual.

Recorded local run

See what a release check returns.

codeproof / manual.mdoffline
$ codeproof check manual.md --pdf dist/manual.pdf --out proof

READ   47 fenced blocks · 12 internal links
CHECK  page bounds · annotations · text flow · color
ERROR  [geometry.text-overflow] page 38 · x=521.6pt
WARN   [code.highlight-not-detected] source line 914
WRITE  proof/index.html

HOLD — 184 pages, 47 code blocks, 1 error, 1 warning
Exit 1No files uploaded

Release contract / v0.1

Checks aimed at expensive mistakes.

Code flow

Flags source lines that disappear or stop following their original fenced order.

code.*

Page bounds

Estimates painted text width from PDF content operations and reports the page.

geometry.*

Internal links

Validates Markdown fragments, then counts link annotations in the final PDF.

link.*

Syntax color

Warns when language-tagged blocks produce no detectable non-default PDF color.

highlight.*

Pull a proof

Put it beside your renderer.

Build the 0.1 binary with Rust, then point it at a source/PDF pair. No account, upload, daemon, or telemetry.

Read the full CLI reference
01 / buildcargo install --path cli
02 / inspectcodeproof check manual.md --pdf manual.pdf
03 / CIcodeproof check manual.md --pdf manual.pdf --json

A boundary, honestly stated

Local by design. Sandboxed by your system.

Code Proof runs renderers with a clean environment, fixed arguments, an isolated temporary workspace, and a deadline. It never executes Markdown scripts. Process cleanup is not an OS security boundary; keep untrusted documents inside your CI or container sandbox.