توليد المستندات

الاستخدام الثانوي لـ configlet هو توليد المستندات.

الاستخدام

يمكن استخدام الأمر generate لتوليد مستندات التعليمات/المقدمات من قالب.

configlet [global-options] generate

Global options:
  -h, --help                   Show this help message and exit
      --version                Show this tool's version information and exit
  -t, --track-dir <dir>        Specify a track directory to use instead of the current directory
  -v, --verbosity <verbosity>  The verbosity of output. Allowed values: q[uiet], n[ormal], d[etailed]

المستندات

هذه هي المستندات التي يستطيع configlet توليدها.

المستند: ملف introduction.md لتمرين المفاهيم

لكل تمرين مفاهيم ملف introduction.md. ويمكن لكل تمرين أن يحتوي على ملف introduction.md.tpl اختياري.

ينبغي التعامل مع ملف القالب كملف Markdown عادي، مع إضافة واحدة: القدرة على تحديد عناصر نائبة. والعناصر النائبة التالية مدعومة:

• %{concept:<slug>}: يشير إلى مستند introduction.md الخاص بالمفهوم

عندما يكتشف configlet أن تمرين المفاهيم يحتوي على ملف introduction.md.tpl، فإنه يولّد منه ملف introduction.md. وستكون المقدمة المولّدة مطابقة لمحتويات القالب، باستثناء العناصر النائبة، التي ستُستبدل بمحتويات المستندات التي تشير إليها.

المستند: ملف introduction.md لتمرين التطبيق

عندما يكتشف configlet أن تمرين التطبيق يطبّق تمرين مواصفات المسائل الذي يحتوي على ملف introduction.md، فإنه يزامن ملف .meta/introduction.md الخاص بتمرين التطبيق مع ملف introduction.md الخاص بتمرين مواصفات المسائل.

المستند: ملف instructions.md لتمرين التطبيق

عندما يكتشف configlet أن تمرين التطبيق يطبّق تمرين مواصفات المسائل، فإنه يزامن ملف .meta/instructions.md الخاص بتمرين التطبيق مع ملف instructions.md الخاص بتمرين مواصفات المسائل أو ملف description.md الخاص به عندما لا يوجد ملف instructions.md.

المستند: ملف .meta/config.json لتمرين التطبيق

عندما يكتشف configlet أن تمرين التطبيق يطبّق تمرين مواصفات المسائل، فإنه يزامن المفتاحين source وsource_url من ملف metadata.yml الخاص بتمرين مواصفات المسائل إلى الخاصيتين source وsource_url في ملف .meta/config.json الخاص بتمرين التطبيق.