Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

prisma-docs-generator

Package Overview
Dependencies
Maintainers
1
Versions
13
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

prisma-docs-generator

Documentation reference generator for Prisma Schema

  • 0.5.0
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
9.8K
increased by2.68%
Maintainers
1
Weekly downloads
 
Created
Source

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

screenshot

Getting Started

  1. Install this package using:
npm install prisma-docs-generator
  1. Add the generator to the schema
generator docs {
  provider = "node node_modules/prisma-docs-generator"
}
  1. Run npx prisma generate to trigger the generator. This will create a docs folder in prisma/docs
  2. 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"
}

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 )

Keywords

FAQs

Package last updated on 24 Sep 2021

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc