drizzle-docs-generator

5.8easy start · #15 of 27
in Database Documentation Tools

drizzle-docs-generator is ranked #15 of 27 in database documentation tools on The Geeks Club.

Compared on database documentation tools

MySQL 0 of 4 in the starter kit Lesson 17.9 DbSchema 0 of 4 in the starter kit Lesson 27.7 dbForge Studio for PostgreSQL 0 of 4 in the starter kit Lesson 37.6 dbt Semantic Layer 0 of 4 in the starter kit Lesson 47.4 tbls 0 of 4 in the starter kit Lesson 57.2 dbdocs 0 of 4 in the starter kit Lesson 67.1

Purpose: The project describes itself as a CLI tool for generating DBML and Markdown documentation from Drizzle ORM schemas.
JSDoc extraction: It extracts JSDoc comments and converts them to DBML notes.
Schema imports: It supports importing schema files from a directory and extensionless imports.
Relations: It detects relations defined with `defineRelations()` or `relations()`, and can fall back to foreign key constraints.
Output formats: It generates Markdown by default or DBML, with Markdown output supporting multiple files or a single file and an optional ER diagram.
Watch mode: Its watch option regenerates documentation when schema files change.
Database dialects: The documented dialect options are PostgreSQL, MySQL, and SQLite.
Installation: The README recommends local installation as a development dependency and also documents global installation using npm or pnpm.
License: The project is licensed under MIT.

Claim it for free: prove the domain, then correct facts, plans and screenshots. An editor reviews every change.