Docsify 如何在一个 MD 文件中嵌入另外一个文件

在使用 MD 进行文档开发的时候,用的最多就是页面共用。

docsify 已经提供了这个功能,你不仅仅可以嵌入 md 文件,你还可以嵌入一些不同的文件类型。

嵌入方式

可以使用下面的方式进行嵌入。

[filename](_media/example.md ':include')

在链接到 md 文件后,在文件的后端添加参数:‘:include’ 就可以了。

需要注意的是 :include 需要单引号来进行包裹。

可以嵌入的文件类型

在当前情况下,一些特定的扩展文件名可以被自动识别,并自动使用类类型。

可以支持的嵌入类型为:

  • iframe .html, .htm
  • markdown .markdown, .md
  • audio .mp3
  • video .mp4, .ogg
  • code 其他文件类型

当然,你也是可以强制指定嵌入文件的类型的。

例如下面的代码:

[filename](_media/example.md ':include :type=code')

在执行后,将会得到下面的内容:

> This is from the `example.md`

这是因为在上面的嵌入方式中,我们强制指定 example.md 的类型为 代码了。

如果不强制指定类似的话,docsify 将会自动将 example.md 中的内容合并到当前页面中。

docsify-01

例如在代码中使用的上面的代码,就可以完成嵌入了。