👋Learning to code? Check out ourbrand new Bootcampfor beginners!
The secondary use of configlet is generating documents.
The generate command can be used to generate instructions/introductions documents from a template.
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]
These are the documents that configlet can generate.
Each Concept Exercise has an introduction.md file. Each exercise can have an optional introduction.md.tpl file.
The template file should be treated like a regular Markdown file but with one addition: the ability to specify placeholders. The following placeholders are supported:
%{concept:<slug>}: refers to the concept's introduction.md document
When configlet detects that a Concept Exercise has an introduction.md.tpl file, it will generate a introduction.md file from it. The generated introduction will have the same contents as the template, except for the placeholders, which will be replaced with the contents of the documents they refer to.
When configlet detects that a Practice Exercise implements a Problem Specifications Exercise that has an introduction.md file, configlet will sync the Practice Exercise's .meta/introduction.md file with the Problem Specification Exercise's introduction.md file.
When configlet detects that a Practice Exercise implements a Problem Specifications Exercise, configlet will sync the Practice Exercise's .meta/instructions.md file with either the Problem Specifications Exercise's instructions.md file or its description.md file when no instructions.md file was found.
When configlet detects that a Practice Exercise implements a Problem Specifications Exercise, configlet will sync the Problem Specification Exercise's source and source_url keys from its metadata.yml file to the Practice Exercise's source and source_url properties in its .meta/config.json file.