npm 包 hexo-include-markdown 使用教程

前言

在前端开发中,我们通常使用 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 的内容如下:

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

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

猜你喜欢

  • npm 包 vue-countdown-component 使用教程

    简介 vue-countdown-component 是一个基于 Vue.js 的倒计时组件,并且支持单向和双向计时。 安装 在你的项目目录下使用 npm 安装 vue-countdown-compo...

    3 年前
  • npm 包 react-native-tabbar-bottom 使用教程

    React Native 是目前比较流行的一款跨平台开发框架,相信广大前端开发者都会喜欢和使用它。其中,组件库是 React Native 开发中极其重要的一环,而 react-native-tabb...

    3 年前
  • npm 包 smart-terminal 使用教程

    随着前端技术的不断发展,越来越多的工具和框架出现,极大地提高了开发效率。其中,npm 包是一种非常重要的前端工具。本文将介绍一个常用的 npm 包 smart-terminal,讲解其使用方法并提供详...

    3 年前
  • npm 包 jspdf-npm-packages 使用教程

    在前端开发中,如何生成 PDF 文件是一个重要的话题。幸运的是,我们可以使用 npm 包 jspdf-npm-packages 来轻松地生成 PDF 文件。 什么是 jspdf-npm-package...

    3 年前
  • npm 包 nwp-color-picker 使用教程

    随着前端技术的不断发展,越来越多的库和工具被开发出来,其中有很多都是通过 npm 进行包管理和发布的。在这篇文章中,我将为大家介绍一个非常实用的 npm 包 - nwp-color-picker。

    3 年前
  • npm 包 aurelia-notifications 使用教程

    简介 aurelia-notifications 是一个基于 aurelia 框架的用于创建通知的 npm 包。该包使用 Bootstrap 来创建通知并且支持多种通知类型。

    3 年前
  • npm 包 docker-container-id 使用教程

    在使用 Docker 构建应用程序的过程中,我们经常会使用到容器 ID。但是在某些情况下,我们可能需要在应用程序中动态地获取到当前容器的 ID,这个时候就需要使用到 docker-container-...

    3 年前
  • npm 包 essed 使用教程

    什么是 essed essed 是一个开源的 JavaScript 库,它提供基于正则表达式的文本分析和编辑功能,可以用于前端和 Node.js 开发中,是一款非常实用的 npm 包。

    3 年前
  • npm 包 react-roadway 使用教程

    在现代 web 开发中,组件化成为了一种流行的编程模式。React 作为当下最为流行的 web 前端库,其组件化思想被广泛应用。而 react-roadway 就是一个基于 React 的组件化库,它...

    3 年前
  • npm 包 svenskify 使用教程

    欢迎来到本文,本文将为您介绍一个非常好用的 npm 包:svenskify,它是一个将英文文本转换成瑞典语的工具。本文将为您提供详细的使用教程,包括如何安装、如何使用、以及一些注意事项等内容。

    3 年前
  • npm 包 cordova-plugin-open-keyboard 使用教程

    近年来,移动端App的应用已经成为人们生活中必不可少的一部分,而在这些App中输入框的使用频率也越来越高。在Android系统中默认系统键盘是关闭的,如果需要使用键盘,需要在屏幕上点击文本框才会弹出。

    3 年前
  • npm 包 express-json-success 使用教程

    在前端开发中,使用 npm 包是实现许多功能的常用方法之一。而其中一个非常有用的 npm 包是 express-json-success,它可以简化我们在用 express.js 开发 API 时,返...

    3 年前
  • npm 包 node-net-reconnect 的使用教程

    在前端开发过程中,我们经常需要使用网络编程来与服务器端进行通信。而在实际工作中,我们会发现网络环境不稳定,有时候会出现连接中断的情况,这就会导致程序异常退出或无法继续执行。

    3 年前
  • npm 包 react-native-iqkeyboard-manager 使用教程

    在移动端开发中,处理键盘弹出和收起的问题一直是前端开发中比较常见的问题。而 react-native-iqkeyboard-manager 就是为解决这一问题而开发的 npm 包。

    3 年前
  • npm 包 blunt 使用教程

    前言 在前端开发中,我们经常需要使用 JavaScript 来处理数据,在这个过程中,我们可能需要编写一些复杂的计算或算法,这时候,就可以使用 npm 包 blunt 来帮助我们处理这些任务。

    3 年前
  • npm 包 blast-template 使用教程

    在前端开发过程中,模板引擎是必不可少的工具。npm 包 blast-template 是一款非常好用的模板引擎,它可以使你的页面更易于维护和开发。本篇文章将介绍 blast-template 的使用教...

    3 年前
  • npm 包 pull-next-step 使用教程

    在前端开发中,经常需要处理异步流程或者迭代操作。处理这些操作需要编写大量的代码,而且容易出错。如果有一个简单易用的工具能够管理异步流程或者迭代操作,将会大大提高开发效率。

    3 年前
  • npm 包 modern-chart 使用教程

    前言 如今,随着互联网技术的不断发展,前端工程师对于数据可视化的需求日益增加。而现在,使用开源的 npm 包现成的图表库已经成为了前端开发工作中必不可少的一部分,现在我们介绍一个优秀的 npm 包——...

    3 年前
  • npm 包 crox-gulp 使用教程

    前言 在前端开发中,我们经常需要将一些源代码转换成可运行的格式,例如将 less 转换成 css,将 es6 转换成 es5 等。而实现这些转换的工具有很多,其中一种比较流行的工具就是 gulp。

    3 年前
  • npm 包 map-promised 使用教程

    在开发前端项目的过程中,我们经常需要对数组或对象进行处理,而使用 map 方法是常见的处理方式。但是,map 方法返回的是一个新的数组或对象,而我们在使用 map 方法处理数组或者对象时,有些时候希望...

    3 年前

相关推荐

    暂无文章