A configlet másodsorban dokumentumok generálására szolgál.
Használat
A generate paranccsal sablonból generálhatsz instructions/introduction dokumentumokat.
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]
Dokumentumok
A configlet az alábbi dokumentumokat tudja generálni.
Dokumentum: a tanulófeladat introduction.md fájlja
Minden tanulófeladatnak van egy introduction.md fájlja. Ezen kívül minden feladathoz tartozhat egy opcionális introduction.md.tpl fájl is.
A sablonfájlt úgy kezeld, mint egy hagyományos Markdown-fájlt, egyetlen kiegészítéssel: lehet benne helyőrzőket megadni. Az alábbi helyőrzőket támogatja:
Amikor a configlet észleli, hogy egy tanulófeladatnak van introduction.md.tpl fájlja, abból generál egy introduction.md fájlt. A generált introduction tartalma megegyezik a sablonéval, kivéve a helyőrzőket, amelyek helyére a hivatkozott dokumentumok tartalma kerül.
Dokumentum: a gyakorlófeladat introduction.md fájlja
Amikor a configlet észleli, hogy egy gyakorlófeladat egy olyan Problem Specifications feladatot valósít meg, amelynek van introduction.md fájlja, szinkronizálja a gyakorlófeladat .meta/introduction.md fájlját a Problem Specifications feladat introduction.md fájljával.
Dokumentum: a gyakorlófeladat instructions.md fájlja
Amikor a configlet észleli, hogy egy gyakorlófeladat egy Problem Specifications feladatot valósít meg, szinkronizálja a gyakorlófeladat .meta/instructions.md fájlját a Problem Specifications feladat instructions.md fájljával, vagy ha nem található instructions.md fájl, akkor a description.md fájljával.
Amikor a configlet észleli, hogy egy gyakorlófeladat egy Problem Specifications feladatot valósít meg, átmásolja a Problem Specifications feladat metadata.yml fájljából a source és source_url kulcsokat a gyakorlófeladat .meta/config.json fájljában lévő source és source_url tulajdonságokba.
