prisma-markdown

Prisma Markdown

Outline

Prisma markdown documents generator.

• Mermaid ERD diagrams
• Descriptions written by /// comments
• Separations by @tag comments

Setup

At first, install NPM package.

npm i -D prisma-markdown

At next, add the generator to the schema file.

generator markdown {
  provider = "prisma-markdown"
  output   = "./ERD.md"
}

At last, run below command, than ERD.md file would be generated.

npx prisma generate

Demonstration

You can see how markdown document being generated:

• Prisma schema file: schema.prisma
• Generated markdown: ERD.md