ডকুমেন্ট তৈরি করা

configlet-এর গৌণ ব্যবহার হলো ডকুমেন্ট জেনারেট করা।

ব্যবহার

generate কমান্ডটি দিয়ে একটি টেমপ্লেট থেকে instructions/introduction ডকুমেন্ট জেনারেট করা যায়।

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-এর বিষয়বস্তু টেমপ্লেটের মতোই হবে, তবে প্লেসহোল্ডারগুলো ছাড়া, যেগুলো তাদের নির্দেশ করা ডকুমেন্টের বিষয়বস্তু দিয়ে প্রতিস্থাপন করা হবে।

ডকুমেন্ট: প্র্যাকটিস অনুশীলনীর introduction.md ফাইল

configlet যখন শনাক্ত করে যে একটি প্র্যাকটিস অনুশীলনী এমন একটি Problem Specifications অনুশীলনী বাস্তবায়ন করে যার একটি introduction.md ফাইল আছে, তখন configlet প্র্যাকটিস অনুশীলনীর .meta/introduction.md ফাইলটি Problem Specifications অনুশীলনীর introduction.md ফাইলের সাথে সিঙ্ক করবে।

ডকুমেন্ট: প্র্যাকটিস অনুশীলনীর instructions.md ফাইল

configlet যখন শনাক্ত করে যে একটি প্র্যাকটিস অনুশীলনী একটি Problem Specifications অনুশীলনী বাস্তবায়ন করে, তখন configlet প্র্যাকটিস অনুশীলনীর .meta/instructions.md ফাইলটি Problem Specifications অনুশীলনীর instructions.md ফাইলের সাথে সিঙ্ক করবে, অথবা কোনো instructions.md ফাইল না পাওয়া গেলে তার description.md ফাইলের সাথে সিঙ্ক করবে।

ডকুমেন্ট: প্র্যাকটিস অনুশীলনীর .meta/config.json ফাইল

configlet যখন শনাক্ত করে যে একটি প্র্যাকটিস অনুশীলনী একটি Problem Specifications অনুশীলনী বাস্তবায়ন করে, তখন configlet Problem Specifications অনুশীলনীর metadata.yml ফাইলের source ও source_url কী (key) থেকে প্র্যাকটিস অনুশীলনীর .meta/config.json ফাইলের source ও source_url প্রপার্টিতে সিঙ্ক করবে।