{"id":13474958,"url":"https://github.com/pantharshit00/prisma-docs-generator","last_synced_at":"2025-05-15T17:01:41.929Z","repository":{"id":40930481,"uuid":"278720665","full_name":"pantharshit00/prisma-docs-generator","owner":"pantharshit00","description":"Prisma generator for automatically generating documentation reference from the Prisma schema.","archived":false,"fork":false,"pushed_at":"2024-03-20T09:16:05.000Z","size":740,"stargazers_count":608,"open_issues_count":20,"forks_count":27,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-31T21:45:16.158Z","etag":null,"topics":["code-generation","hacktoberfest","html","prisma","prisma-generator","prisma2"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pantharshit00.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-07-10T19:49:10.000Z","updated_at":"2025-03-30T09:14:59.000Z","dependencies_parsed_at":"2024-06-18T15:26:12.174Z","dependency_job_id":"4f3ea0d2-9480-499b-a757-550b04fe2ae0","html_url":"https://github.com/pantharshit00/prisma-docs-generator","commit_stats":{"total_commits":58,"total_committers":6,"mean_commits":9.666666666666666,"dds":0.1724137931034483,"last_synced_commit":"0d34b37813e2f36b700a3c402b071ec848a42da7"},"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pantharshit00%2Fprisma-docs-generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pantharshit00%2Fprisma-docs-generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pantharshit00%2Fprisma-docs-generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pantharshit00%2Fprisma-docs-generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pantharshit00","download_url":"https://codeload.github.com/pantharshit00/prisma-docs-generator/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247737769,"owners_count":20987718,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["code-generation","hacktoberfest","html","prisma","prisma-generator","prisma2"],"created_at":"2024-07-31T16:01:16.247Z","updated_at":"2025-04-07T22:06:47.093Z","avatar_url":"https://github.com/pantharshit00.png","language":"TypeScript","funding_links":[],"categories":["TypeScript",":safety_vest: Community Prisma Tools"],"sub_categories":[],"readme":"## Prisma Documentation Generator\n\nAutomatically generate a reference from your Prisma Schema. This package contains a prisma generator so reference will automatically update everytime you will run `prisma generate`\n\n![screenshot](https://user-images.githubusercontent.com/22195362/89097596-edeadc00-d3fd-11ea-91ea-86d5d8076da0.png)\n\n## Getting Started\n\n1. Install this package using:\n\n```shell\nnpm install -D prisma-docs-generator\n```\n\n2. Add the generator to the schema\n\n```prisma\ngenerator docs {\n  provider = \"node node_modules/prisma-docs-generator\"\n}\n```\n\n3. Run `npx prisma generate` to trigger the generator. This will create a `docs` folder in `prisma/docs`\n4. Serve the docs using `npx prisma-docs-generator serve`\n\n## Options\n\n### Specifying Output\n\nYou can specify the out of the docs using the output property\n\n```prisma\ngenerator docs {\n  provider = \"node node_modules/prisma-docs-generator\"\n  output = \"../../docs\"\n}\n```\n\n### includeRelationFields\n\nYou can specify whether relation fields are shown or not.\nDefault value is `true`.\n\n```prisma\ngenerator docs {\n  provider = \"node node_modules/prisma-docs-generator\"\n  includeRelationFields = false\n}\n```\n\n## CLI\n\nThis package also ships with a CLI which is used to serve the docs right now. It has the following subcommands:\n\n### `serve`\n\nServes the static html which the generator generated. It reads the output path from the prisma schema or it will use the default.\nUse `--port` or `-p` to change the port the express server uses.\n\n---\n\n### License\n\nMIT Harshit Pant\n\n(This is not an official Prisma project. It is personally maintained by [me](https://github.com/pantharshit00) )\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpantharshit00%2Fprisma-docs-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpantharshit00%2Fprisma-docs-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpantharshit00%2Fprisma-docs-generator/lists"}