prismadocify

生成Prisma模式的文檔。

Prismadocify

prismadocify是一種命令行工具，可生成Prisma Schemas的Markdown文檔。它讀取您的Prisma架構文件，解析模型和枚舉，並輸出記錄模式的Markdown文件。

hacktoberfest 2024 ??

該項目正在參加Hacktoberfest 2024！

我們歡迎開源社區的貢獻，無論是錯誤修復，功能實現還是文檔改進。每個貢獻都針對您的Hacktoberfest目標。

如何貢獻

1. 分叉此存儲庫並創建一個新的分支。
2. 找到要處理的問題，或通過打開問題提出新功能。
3. 在10月31日之前提交您的拉請求，以使其計入Hacktoberfest！

查看我們的貢獻。 md以獲取詳細指南。

---

特徵

以下是prismadocify的一些關鍵特徵：

• Markdown文檔生成：自動為您的Prisma模式生成結構良好的標記文檔。
• 對模型和枚舉的支持：記錄您的Prisma模型和枚舉，並具有表格的輸出。
• 可自定義路徑（即將推出）：為架構輸入和輸出文檔指定自定義路徑。

安裝

先決條件

• node.js（> = 16.x）
• 紗線或npm

通過NPM安裝

npm install prismadocify

通過紗線安裝

yarn add prismadocify

用法

安裝prismadocify後，您可以從命令行使用它來為Prisma模式生成文檔。

命令

prismadocify

默認情況下， prismadocify在./prisma/schema.prisma上查找Prisma架構文件，並在./prisma-docs.md中生成文檔。

例子

這是一個簡單的Prisma模式和生成的文檔的示例：

Prisma模式（ schema.prisma ）

 model User {
  id         String   @id @default ( uuid () )
  email      String   @unique
  name       String ?
  createdAt  DateTime @default ( now () )
}

enum UserRole {
  ADMIN
  USER
}

生成的降價文檔（ prisma-docs.md ）

 # Prisma Schema Documentation

## User

| Field     | Type     | List | Required | Unique |
| --------- | -------- | ---- | -------- | ------ |
| id        | String   | No   | Yes      | Yes    |
| email     | String   | No   | Yes      | Yes    |
| name      | String?  | No   | No       | No     |
| createdAt | DateTime | No   | Yes      | No     |

## Enums

### UserRole

ADMIN, USER

---

貢獻

我們歡迎各種貢獻！首先，請參閱有關如何為該項目做出貢獻的指南的貢獻。

執照

該項目已根據MIT許可獲得許可。

致謝

感謝Prisma團隊為此工具提供了很棒的ORM和靈感。