prisma-docs-generator

Prisma Documentation Generator

Automatically generate a reference from your Prisma Schema. This package contains a prisma generator so reference will automatically update everytime you will run prisma generate

Getting Started

1. Install this package using:

npm install -D prisma-docs-generator

2. Add the generator to the schema

generator docs {
  provider = "node node_modules/prisma-docs-generator"
}

3. Run npx prisma generate to trigger the generator. This will create a docs folder in prisma/docs
4. Serve the docs using npx prisma-docs-generator serve

Options

Specifying Output

You can specify the out of the docs using the output property

generator docs {
  provider = "node node_modules/prisma-docs-generator"
  output = "../../docs"
}

includeRelationFields

You can specify whether relation fields are shown or not. Default value is true.

generator docs {
  provider = "node node_modules/prisma-docs-generator"
  includeRelationFields = false
}

CLI

This package also ships with a CLI which is used to serve the docs right now. It has the following subcommands:

serve

Serves the static html which the generator generated. It reads the output path from the prisma schema or it will use the default. Use --port or -p to change the port the express server uses.

---

License

MIT Harshit Pant

(This is not an official Prisma project. It is personally maintained by me )