生成文档

configlet 的次要用途是生成文档。

用法

可以用 generate 命令从模板生成 instructions/introductions 文档。

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 检测到某个实践练习实现了某个带有introduction.md文件的问题规范练习时，configlet 会把该实践练习的.meta/introduction.md文件与问题规范练习的introduction.md文件同步。

文档：实践练习的 instructions.md 文件

当 configlet 检测到某个实践练习实现了某个问题规范练习时，configlet 会把该实践练习的.meta/instructions.md文件与问题规范练习的instructions.md文件同步；如果没有找到instructions.md文件，则改为与其description.md文件同步。

文档：实践练习的 .meta/config.json 文件

当 configlet 检测到某个实践练习实现了某个问题规范练习时，configlet 会把问题规范练习的metadata.yml文件中的source和source_url键同步到该实践练习.meta/config.json文件中的source和source_url属性。