prisma-docs-generator
    TypeScript icon, indicating that this package has built-in type declarations

    0.5.0 • Public • Published

    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 )

    Install

    npm i prisma-docs-generator

    DownloadsWeekly Downloads

    3,150

    Version

    0.5.0

    License

    MIT

    Unpacked Size

    169 kB

    Total Files

    54

    Last publish

    Collaborators

    • pantharshit00