Overview

The Prisma Documentation Generator is a transformative tool designed to automatically create reference documentation from your Prisma schema. This package is particularly useful for developers looking to streamline their documentation process, as it ensures that documentation stays up-to-date with each run of the Prisma generator. With just a few simple commands, you can effortlessly manage your project's documentation.

Whether you're a seasoned developer or just starting out with Prisma, the generator’s ability to create a dedicated documentation folder makes it a valuable addition to your toolkit. The integrated CLI enhances user experience by allowing for easy serving of the generated documentation, ensuring that your essential reference material is always within reach.

Features

Automatic Updates: The documentation is auto-generated and updated every time you run the Prisma generate command, which helps maintain accuracy and relevance.
Custom Output Location: You can specify a custom output directory for the generated documentation using the output property in the schema.
Optional Relation Fields: The generator offers flexibility in displaying relation fields, allowing you to show or hide them based on your preferences. The default setting is to include them.
Integrated CLI: The package includes a command-line interface (CLI) to serve the generated documentation easily, providing a straightforward way to access and view your docs.
Custom Port Configuration: Users can modify the port used by the express server to serve documentation, making it adaptable to different development environments.
MIT License: It is open-sourced under the MIT license, allowing developers to use and contribute to the project freely.
Personal Maintenance: Though not officially part of Prisma, it is actively maintained by Harshit Pant, ensuring that it remains functional and updated.

Pantharshit00

Prisma Docs Generator