SchemaCrawler Scribe: Database Documentation as an OKF Bundle #213

sualeh · 2026-07-20T15:29:06Z

sualeh
Jul 20, 2026

SchemaCrawler Scribe produces clean, navigable Markdown documentation from live database metadata, packaged as an OKF bundle.
Supports all major relational databases including PostgreSQL, MySQL, MariaDB, Oracle, Microsoft SQL Server, IBM DB2, Snowflake, SQLite, and more.
GitHub Docs frontmatter is included in every generated page, allowing the OKF bundle to be turned into a full website using standard static‑site tools like Hugo or Jekyll on GitHub Pages.
Cross‑linked schema navigation: tables, columns, routines, and foreign keys become Markdown links, with auto‑generated directory indexes for easy browsing.
Mermaid diagrams are embedded directly into Markdown to visualize relationships and structure.
Comprehensive schema coverage: tables, columns, keys, constraints, routines, triggers, references, cross‑reference pages, and optional lint or anomaly reports.
Localized output supports multiple languages for international teams.
Git‑native workflow: everything is plain text, diff‑friendly, and ideal for version control. It is deterministically generated for the same database schema.