引言
猫鼬子(Mdoc)是一款基于 Markdown 语法的文档生成工具,其主要特点是支持多种格式的输出,如 HTML、PDF、EPUB 等,同时还支持自定义主题和插件。在前端开发中,我们通常会用到猫鼬子来撰写技术文档或者 API 文档,本文将介绍如何使用猫鼬子的嵌套模式来更好地管理文档。
猫鼬子嵌套模式
猫鼬子的嵌套模式可以理解为在一个 markdown 文件中引用另外一个 markdown 文件,类似于 HTML 中的 iframe 标签。使用嵌套模式,我们可以将文档拆分成不同的部分并且各自独立地编写和维护,同时又能够方便地组合成一个完整的文档。
嵌套语法
猫鼬子使用 {% mdr %}
和 {% endmdr %}
标签表示嵌套的部分。例如:
- --- ---------- -- --- ------------------- -- -- ------ --
上述代码片段中,{% mdr %}
标签中的 "path/to/nested.md"
表示要嵌套的文件路径。当猫鼬子生成文档时,会自动将被嵌套的文档内容插入到主文档中。
嵌套示例
下面是一个使用嵌套模式的示例,假设我们需要编写一个 API 文档,包含多个接口的说明和示例代码。我们可以将每个接口的说明和示例代码分别写成不同的 markdown 文件,再将它们嵌套到主文档中。
首先,我们创建一个 api.md
文件作为主文档,并在其中引用每个接口对应的 markdown 文件:
- --- -- -- -- - -- --- ----------------- -- -- ------ -- -- -- - -- --- ----------------- -- -- ------ --
然后,我们编写每个接口对应的 markdown 文件。以接口 1 为例,我们可以这样编写:
--- -- - ---- - ---- ------------- -- -- - -----
{% mdr "path/to/api1-1.md" %} {% endmdr %}
----------- --- ------------------- --- ----------------------------- --------------------------- --- --- -- ----- ------------------------------------------------------------------------------ ------------------------------------------------------------------ -- ---- -------------- - ----------------------------------------------------------- -------- ---------------------------------------------------------------------------------------