- Home
- Database Documentation Tools
- drizzle-docs-generator
On the recordRead 9 Oct 202616 facts
drizzle-docs-generator
On the record
- Audience
- The maker recommends it for Drizzle users who want to keep schema definitions and documentation in sync.zenn.dev · read 9 Oct 2026
- CI/CD use
- The maker describes incorporating the tool into CI/CD to update documentation when schemas change.zenn.dev · read 9 Oct 2026
- Database dialects
- The documented dialect options are PostgreSQL, MySQL, and SQLite.github.com · read 4 Oct 2026
- DBML output
- The generated DBML can be imported into dbdiagram.io to view ER diagrams and table definitions.zenn.dev · read 9 Oct 2026
- Installation
- The maker documents installation through npm or pnpm, as a development dependency or globally.zenn.dev · read 9 Oct 2026
- JSDoc comments
- JSDoc comments on table and column definitions are included in the generated documentation.zenn.dev · read 9 Oct 2026
- JSDoc extraction
- It extracts JSDoc comments and converts them to DBML notes.github.com · read 4 Oct 2026
- License
- The GitHub repository lists the project under the MIT license.github.com · read 9 Oct 2026
- Markdown output
- Markdown output can include a table list, Mermaid ER diagram, and separate documentation for each table.zenn.dev · read 9 Oct 2026
- Output formats
- It generates Markdown by default or DBML, with Markdown output supporting multiple files or a single file and an optional ER diagram.github.com · read 4 Oct 2026
- Output options
- Markdown can be generated as a single file, and its ER diagram can be excluded with an option.zenn.dev · read 9 Oct 2026
- Purpose
- The CLI generates Markdown documentation and DBML table definitions from Drizzle ORM schemas.zenn.dev · read 9 Oct 2026
- Relations
- The maker says the tool supports both Drizzle relation definition styles, including v0 and v1.zenn.dev · read 9 Oct 2026
- Schema dialects
- The tool supports MySQL, PostgreSQL, and SQLite schema definitions.zenn.dev · read 9 Oct 2026
- Schema imports
- It supports schemas split across multiple files by accepting a schema directory as input.zenn.dev · read 9 Oct 2026
- Watch mode
- Its watch option regenerates documentation when schema files change.github.com · read 4 Oct 2026
