کاربرد دوم 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 معمولی رفتار شود، با این تفاوت که میتوان در آن «جانگهدار» تعیین کرد. جانگهدارهای زیر پشتیبانی میشوند:
وقتی configlet تشخیص دهد که یک تمرین مفهومی فایل introduction.md.tpl دارد، از روی آن یک فایل introduction.md تولید میکند. معرفی تولیدشده همان محتوای قالب را خواهد داشت، بهجز جانگهدارها که با محتوای اسنادی که به آنها اشاره میکنند جایگزین میشوند.
سند: فایل introduction.md تمرین عملی
وقتی configlet تشخیص دهد که یک تمرین عملی، یک تمرین Problem Specifications را پیادهسازی میکند که فایل introduction.md دارد، فایل .meta/introduction.md تمرین عملی را با فایل introduction.md تمرین Problem Specifications همگامسازی میکند.
سند: فایل instructions.md تمرین عملی
وقتی configlet تشخیص دهد که یک تمرین عملی، یک تمرین Problem Specifications را پیادهسازی میکند، فایل .meta/instructions.md تمرین عملی را با فایل instructions.md تمرین Problem Specifications یا، در صورتی که هیچ فایل instructions.md یافت نشود، با فایل description.md آن همگامسازی میکند.
وقتی configlet تشخیص دهد که یک تمرین عملی، یک تمرین Problem Specifications را پیادهسازی میکند، کلیدهای source و source_url تمرین Problem Specifications را از فایل metadata.yml آن به ویژگیهای source و source_url تمرین عملی در فایل .meta/config.json آن همگامسازی میکند.
