Skip to main content

Stop Broken Links in 60s

· 3 min read
PythonWoods
PythonWoods
Creator of Zenzic

Your docs have broken links. You just haven't found them yet.

Zenzic finds them before your readers do — before you build, before you deploy, before it's too late.

New to Zenzic?

This tutorial gets you from zero to first audit in 60 seconds. After that, explore how Zenzic was built in The Zenzic Chronicles →

Step 1 — Launch​

No install. No virtual environment. One command:

Terminal
uvx zenzic check all ./docs

No browser, no build engine, no heavy framework — a single Python tool cached on first run and ready in seconds from then on.

Step 2 — Read the Report​

You'll see one of two results:

All clear:

✨ Sentinel Seal: All checks passed. Your documentation is clean.

Issues found:

✘docs/guide.mdZ101Broken link → ./missing-page.md
✘docs/old-api.mdZ402Orphan page — not linked from navigation
✘docs/config.mdZ201Shield: credential pattern detected
✘ 3 errorsFiles: 42 · Elapsed: 0.31 s

Each finding carries a Zxxx code, a file path, a line number, and a clear description. Fix what's flagged, re-run, and ship with confidence.

Step 3 — Protect Your CI​

One line in your GitHub Actions workflow:

.github/workflows/zenzic.yml

- name: Audit documentation

  run: uvx zenzic check all ./docs

Every pull request is now guarded. Broken links, orphan pages, and leaked credentials are caught before they reach main.

Why Zenzic​

  • Fast — Zenzic is fast because it's lightweight. No build step, no Node.js,

    no browser launch. Analysis happens directly on your Markdown source files.

  • Safe — Zenzic is secure because it doesn't touch your system files.

    Read-only analysis, always. Your repository is observed, never modified.

  • Universal — Works with MkDocs, Docusaurus, Zensical, or any plain Markdown folder.

    Point it at your docs/ directory and it figures out the rest.

Go Further​

CommandWhat it does
uvx zenzic check allFull audit: links, orphans, credentials, snippets
uvx zenzic check linksLink integrity only
uvx zenzic scoreQuality score with trend tracking
uvx zenzic check all --format sarifSARIF output for GitHub Code Scanning

Pin a specific version for reproducible CI:

Terminal
uvx "zenzic==0.7.0" check all ./docs

The full engineering story behind Zenzic — from the first broken pipe to Quartz Maturity — lives in The Zenzic Chronicles →

For a 1,525-line architectural deep-dive into every Zenzic component — verified by 1,301 tests across Python 3.11, 3.12, and 3.13 — see the Obsidian Masterclass →.