npm 包 hexo-include-markdown 使用教程

阅读时长 3 分钟读完

前言

在前端开发中,我们通常使用 Hexo 来搭建个人博客,而在博客编写过程中,我们经常会引用其他 Markdown 文件中的内容。这时,我们就需要用到 npm 包 hexo-include-markdown。本文将介绍这个包的使用方法及注意事项。

安装

在使用 hexo-include-markdown 之前,需要先安装到博客项目中:

使用方法

在 Markdown 文件中使用 hexo-include-markdown 来引用其他 Markdown 文件中的内容,具体如下:

其中,path 为被引用 Markdown 文件的相对路径。注意,引用的文件应当与当前文件在同一目录下或在更高级目录中。

例如,本文的示例代码所在路径为 ~/articles/hexo-include-markdown-tutorial,引用目标文件的路径为 ~/articles/hexo-tutorial/README.md,则引用语句为:

另外,hexo-include-markdown 还支持为被引用的 Markdown 文件设置标题、添加样式等操作,具体如下:

注意事项

在引用过程中,有几个需要注意的点:

  1. 引用语句中的路径需要用双引号包裹
  2. 被引用的 Markdown 文件需要存在于本地磁盘中
  3. 引用过程中,被引用的 Markdown 文件中不支持 Hexo 标志,例如 {{ title }}

示例

以下是一个示例,用于展示 hexo-include-markdown 的具体应用。

例 1:描述你对 hexo-include-markdown 的看法。

文件 opinion.md 的内容如下:

例 2:在文章中引用一个代码片段。

文件 code.md 的内容如下:

纠错
反馈