مستندات العضلة ذات الرأسين

جدول المحتويات

• وصف

• تثبيت

• متطلبات

• الاستخدام

• المساهمة

• رخصة

وصف

bicep-docs هي أداة سطر أوامر تقوم بإنشاء وثائق لقوالب Bicep.

تثبيت

البيرة المنزلية

 صنبور المشروب كريستوسجالانو/كريستوسجالانو
الشراب تثبيت العضلة ذات الرأسين مستندات

يذهب

 اذهب لتثبيت github.com/christosgalano/bicep-docs/cmd/bicep-docs@latest

ثنائي

قم بتنزيل أحدث ثنائي من صفحة الإصدارات.

متطلبات

لتشغيل مستندات bicep، يجب تثبيت Azure CLI أو Bicep CLI.

سطر الأوامر	الحد الأدنى من الإصدار المطلوب
أزور	2.64.0
العضلة ذات الرأسين	0.29.0

الاستخدام

bicep-docs هي أداة سطر أوامر تقوم بإنشاء وثائق لقوالب Bicep.

بالنظر إلى ملف أو دليل إدخال Bicep، فإنه يقوم بتحليل الملف (الملفات) وإنشاء الوثائق المقابلة بتنسيق Markdown.

يمكن استخدام هذا لإنشاء وتحديث الوثائق تلقائيًا لقوالب العضلة ذات الرأسين الخاصة بك.

إذا كان الإدخال عبارة عن دليل، فسيتم إنشاء ملف README.md لكل main.bicep في نفس الدليل. يحدث هذا بشكل متكرر لكافة الدلائل الفرعية.

إذا كان الإدخال عبارة عن ملف ذات رأسين، فيجب أن يكون الإخراج ملفًا؛ وإلا سيتم إرجاع خطأ.

القيمة الافتراضية للإخراج هي README.md ، نسبة إلى الدليل الذي تم تنفيذ الأمر فيه.

تنبيه: إذا كان ملف Markdown موجودًا بالفعل، فسيتم الكتابة فوقه .

الحجج

فيما يتعلق بالوسيطات --include-sections و --exclude-sections ، فإن الأقسام المتاحة هي: description ، usage ، modules ، resources ، parameters ، و udfs ، و uddts ، variables ، outputs .

الأقسام الافتراضية المطلوبة هي description,usage,modules,resources,parameters,udfs,uddts,variables,outputs . الإدخال الافتراضي لـ --exclude-sections هو '' . وهذا يضمن التوافق مع الإصدارات السابقة مع الإصدار السابق.

يتم احترام ترتيب الأقسام عند تضمينها.

عند استبعاد الأقسام، ستكون النتيجة الأقسام الافتراضية مطروحًا منها الأقسام المستبعدة (على سبيل المثال --exclude-sections description,usage modules,resources,parameters,udfs,uddts,variables,outputs بهذا الترتيب).

لا يمكن توفير كلتا الوسيطتين في نفس الوقت، ما لم تكن وسيطة --include-sections هي نفس الأقسام الافتراضية (على سبيل المثال --include-sections description,usage,modules,resources,parameters,udfs,uddts,variables,outputs ) .

استخدام المثال

تحليل ملف Bicep وإنشاء ملف Markdown:

 bicep-docs --input main.bicep --output readme.md

تحليل ملف Bicep وإنشاء ملف README.md في نفس الدليل:

 العضلة ذات الرأسين-مستندات -i main.bicep

قم بتحليل الدليل وإنشاء ملف README.md لكل ملف main.bicep مع إخراج مطول:

 العضلة ذات الرأسين-docs -i ./bicep -V

تحليل ملف Bicep وإنشاء ملف README.md باستثناء الأقسام المعرفة من قبل المستخدم:

 مستندات العضلة ذات الرأسين - إدخال main.bicep - استبعاد الأقسام udfs، uddts

قم بتحليل ملف Bicep وقم بإنشاء ملف README.md متضمنًا فقط الموارد والوحدات النمطية بهذا الترتيب:

 مستندات العضلة ذات الرأسين --- الإدخال الرئيسي. العضلة ذات الرأسين --تشمل أقسام الموارد والوحدات

يمكن العثور على المزيد من الأمثلة هنا.

تنسيق التوثيق

الوثائق لها التنسيق التالي:

 # اسم الوحدة | اسم الملف## الوصف...## الاستخدام...## الوحدات الثابتة للوحدات النمطية## جدول الموارد للموارد## المعلمات الثابتة للمعلمات## جدول أنواع البيانات المحددة بواسطة المستخدم (UDDTs) لجدول UDDTs## جدول الوظائف المحددة بواسطة المستخدم (UDFs) من UDFS ## متغيرات المتغيرات ## مخرجات قابلة للإخراج

هيكل المجلد

هذه الأداة مفيدة للغاية إذا كنت تتبع هذا الهيكل لمشاريع العضلة ذات الرأسين الخاصة بك:

.
├── bicep
│   │
│   ├── modules
│   │   ├── compute
│   │   │   ├── main.bicep
│   │   │   └── README.md
│   │   └── ...
│   │
│   ├── environments
│   │   ├── development
│   │   │   ├── main.bicep
│   │   │   ├── main.bicepparam
│   │   │   └── README.md
│   │   └── ...

المساهمة

يمكن العثور على معلومات حول المساهمة في هذا المشروع هنا.

رخصة

هذا المشروع مرخص بموجب ترخيص MIT.