如何编写配方
本章演示 Cookbook 配方的标准结构,以及配方中可以使用的文档功能。请同时查看网页中的渲染效果,这比只读源码更容易看清各部分的关系。仓库根目录的 TemplateRecipe.lean 可以直接作为起点。
本书使用 Verso 构建,因此编写配方前需要了解 Verso 的基本标记。以下内容概括本项目最常用的写法。需要完整说明时,请查阅 Verso Manual,也可以参考已有配方的源码。
一个典型配方包含:
-
简短、易读,并能清楚指出所解决问题的标题。
-
简要介绍问题和解决办法的开头。
-
展示解决办法的代码片段。
-
理解代码所需的解释,以及供进一步阅读的资料链接。
-
适合放在同一配方中的后续用法。例如介绍读取普通文件后,可以在小节中补充 JSON、CSV 等文件类型,而不必为每种类型另建配方。每个小标题都应设置 tag 和索引,方便引用。
-
调试技巧、预期错误和进一步用法。
模板源码见这里。