md-scaffold 用于从模板生成结构规范的 Markdown 文件,目标是让文档在首次转换时就能干净通过。它适合新建将转换为 Word、PDF 或邮件的文档,需要统一报告、教程或参考指南结构,或为团队建立一致文档格式的场景。
主要能力:提供 report(含执行摘要、章节、附录、表格)、tutorial(前置条件、学习目标、练习)、reference(命令、参数、示例)、slides(面向 Gamma 的演示,H2 分页与演讲者备注)、email(用于 RFC 5322 头的 YAML frontmatter)五类模板。每个模板包含正确的 frontmatter、扩展语法示例、转换器指令和导航标记(<!-- nav:start --> / <!-- nav:end -->),并可通过 markdown-lint.cjs 校验。
使用方式:通过 Node.js 运行脚本,例如 node .github/muscles/md-scaffold.cjs report "Quarterly Review";可用 --output PATH 指定输出路径,--list 列出模板,--author NAME 设置作者,--force 覆盖已有文件。默认输出为标题 slug 化的 .md 文件。
限制与要求:需要 Node.js 18+,脚本位于 .github/muscles/md-scaffold.cjs(v1.0.0)。默认不覆盖已有文件,需用 --force 或 --output;模板名拼写错误会报模板未找到;手动编辑破坏 YAML 会导致 frontmatter 无效。相关技能包括 md-to-word、md-to-html、md-to-eml、lint-clean-markdown、nav-inject 和 gamma-presentation。