prismadocify
v1.1.3
توليد وثائق لمخططات prisma.
prismadocify هي أداة سطر الأوامر التي تولد وثائق تخفيضات لمخططات Prisma. إنه يقرأ ملف مخطط Prisma الخاص بك ، ويقوم بتوصيف النماذج والعوالم ، ويخرج ملف Markdown الذي يوثق المخطط.
يشارك هذا المشروع في Hacktoberfest 2024!
نرحب بالمساهمات من المجتمع المفتوح المصدر ، سواء كان إصلاحات الأخطاء أو تطبيقات الميزات أو تحسينات الوثائق. كل مساهمة تهم لتحقيق هدف هاكت أكتوبر.
تحقق من المساهمة. md للحصول على إرشادات مفصلة.
فيما يلي بعض الميزات الرئيسية لـ prismadocify :
npm install prismadocifyyarn add prismadocify بعد تثبيت prismadocify ، يمكنك استخدامه من سطر الأوامر لإنشاء وثائق لمخطط Prisma الخاص بك.
prismadocify بشكل افتراضي ، يبحث prismadocify عن ملف مخطط Prisma على ./prisma/schema.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نرحب بالمساهمات من جميع الأنواع! للبدء ، يرجى الاطلاع على المساهمة. md للحصول على إرشادات حول كيفية المساهمة في المشروع.
هذا المشروع مرخص بموجب ترخيص معهد ماساتشوستس للتكنولوجيا.
بفضل فريق Prisma على ORM الرائع والإلهام لهذه الأداة.
