猫鼬子文档与嵌套模式

引言

猫鼬子(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 %}

----------- --- ------------------- --- -----------------------------

--------------------------- --- ---

-- -----

------------------------------------------------------------------------------

------------------------------------------------------------------

-- ----

--------------

----------------------------------------------------------- ----------
---------------------------------------------------------------------------------------
  

猜你喜欢

  • 将JavaScript嵌入到HTML中是不是很糟糕?

    在前端开发中,我们经常需要将JavaScript代码嵌入到HTML文档中。这种做法虽然简单易用,但它也存在一些问题和缺点。 嵌入式JavaScript的问题 可维护性较差 当JavaScript代码与...

    7 年前
  • 如何保存油画与画布上的形象

    背景 在前端开发中,我们通常需要将用户在页面上绘制的内容保存为图片,以便后续使用或分享。而对于涉及到画布(canvas)和油画效果的图片,保存起来可能会有些棘手。本文将介绍如何使用 toDataURL...

    7 年前
  • 使用 jQuery 或 JavaScript 查找页面内存使用

    在前端开发中,优化页面内存使用是一个很重要的问题,特别是当页面上有大量 DOM 元素时。在这篇文章中,我将介绍如何使用 jQuery 或 JavaScript 来查找页面内存使用,并给出一些实用的示例...

    7 年前
  • 如何对抗许多悬而未决的变量在WebStorm警告

    在前端开发中,我们常常会遇到很多悬而未决的变量,在WebStorm中这些变量会被标记为未使用或者未定义,给我们带来不必要的困扰和干扰。本文将介绍如何解决这个问题,并提供一些实用的技巧。

    7 年前
  • 启用跨域资源共享在IIS7

    本文将介绍如何在IIS7上启用 跨域资源共享(CORS),以允许在一个域中的网页请求另一个域中的资源。该过程需要相应的服务器配置和代码更改,但是这将使您的Web应用程序具有更高的灵活性。

    7 年前
  • JavaScript循环通过JSON数组?

    在前端开发中,我们经常需要处理 JSON 数据。其中一个常见的操作是使用循环遍历 JSON 数组中的每个元素,并对其进行处理。本文将介绍如何使用 JavaScript 循环遍历 JSON 数组,并给出...

    7 年前
  • window.location.href和top.location.href之间的差异

    在前端开发中,我们常常需要使用到当前页面的 URL 地址,而 window.location.href 和 top.location.href 都可以获取当前页面的 URL。

    7 年前
  • 动态分配NG模型

    在前端开发中,我们经常需要加载不同的组件或模块。在 Angular 中,我们可以使用 lazy loading 技术来实现动态加载模块。除此之外,我们还可以使用动态分配 NG 模型来更加灵活地管理组件...

    7 年前
  • 从 jQuery 到字符串

    在前端开发中,我们经常需要操作 HTML 元素。其中一个流行的工具是 jQuery,它使得 DOM 操作更加简单和方便。但是,有时候我们需要把一个元素转换成字符串格式以便于传输或者存储。

    7 年前
  • 在JavaScript实现动态的getter和setter

    在JavaScript中,对象可以使用getter和setter方法来访问和修改属性。通常情况下,我们需要明确指定getter和setter方法的名称和参数。但是,在某些情况下,我们可能希望动态地生成...

    7 年前
  • Ajax 和加号(+)——如何编码?

    在前端开发中,我们常常会使用 Ajax 来进行异步数据交互。其中会用到 URL 参数传递数据,而在参数中可能会包含特殊字符,其中就包括了加号(+)。但是,加号在 URL 中有着特殊的含义,所以需要对其...

    7 年前
  • 相反的 push() - unshift()

    在前端编程中,很常见的一种操作是将元素添加到数组中。经常使用的方法是 push(),它可以将一个新元素添加到数组的末尾。但是,在某些情况下,我们需要将元素添加到数组的开头。

    7 年前
  • 如何在特定坐标中定位div?

    在前端开发中,我们经常需要在页面上定位元素。而有时候需要在特定坐标中定位一个 div 元素,这就需要使用 CSS 定位技术。 1. 相对定位 相对定位是指基于元素本身所在的位置进行定位。

    7 年前
  • 将JSON数据转换为HTML表[已关闭]

    很抱歉,我只是一个语言模型,无法输出格式良好的文章。但我可以为您提供相关内容。 将JSON数据转换为HTML表格是前端开发中常用的任务之一。以下是实现此功能的基本步骤: 从服务器获取JSON数据 解...

    7 年前
  • 获取JSON对象上的总项目数?

    JavaScript中,操作JSON对象是非常常见的。在处理JSON对象时,我们可能会需要知道该对象中有多少个键值对。在本文中,我们将探讨如何获取JSON对象上的总项目数。

    7 年前
  • 滚动子div滚动窗口,我该如何停止?

    在web开发中,经常会遇到需要滚动子元素的情况。但是当子元素滚动到一定位置时,有时候需要停止滚动以提供更好的用户体验。 停止滚动的方法 方法1:使用JavaScript 可以使用JavaScript监...

    7 年前
  • jquery.parsejson VS JSON.parse

    在前端开发中,处理JSON数据是非常常见的任务。而在处理JSON数据时,经常需要将一个JSON字符串解析为JavaScript对象。在这种情况下,可以使用jQuery提供的parseJSON()方法或...

    7 年前
  • JavaScript指数

    JavaScript是一门广泛应用于Web开发的编程语言,其生态系统不断扩大和演变。本文将介绍一些JavaScript的重要概念和技术,包括ES6语法、函数式编程、模块化、异步编程和性能优化等内容。

    7 年前
  • 有没有办法放大到D3力布局图?

    D3.js 是一个流行的 JavaScript 库,用于创建强大的交互式数据可视化。其中一种最常用的布局是力布局(Force Layout),它模拟粒子之间的物理力学作用,使得数据点在页面上形成类似于...

    7 年前
  • 消除300ms的时间延迟在移动Safari点击事件

    消除移动 Safari 中的300ms 点击延迟 在移动设备上,浏览器会有一个点击事件的触发延迟,通常是 300 毫秒。这个延迟是由于浏览器需要等待一段时间来判断用户是否进行了双击缩放操作。

    7 年前

相关推荐

    暂无文章