npm 包 hexo-custom-fields 使用教程

1. 什么是 hexo-custom-fields?

Hexo 是一款基于Node.js 的静态博客生成器,它可以将 md 格式的文章转换为静态 HTML 文件。但是,有时候我们需要添加一些自己的自定义字段,比如:文章作者、文章封面、文章摘要等。而 hexo-custom-fields 包就是来满足这个需求的。它可以让我们在文章的 front-matter 里定义自己的字段,然后在生成静态页面的过程中,将这些自定义字段解析出来,合并到我们的模板代码进行显示。

2. 如何使用 hexo-custom-fields?

使用 hexo-custom-fields 包很简单,只需要在你的 Hexo 项目根目录下安装这个包,然后在 _config.yml 配置文件中进行一些简单的配置,即可开始使用自定义字段了。

首先安装 hexo-custom-fields 包:

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

安装完成后,打开你的 Hexo 项目的 _config.yml 配置文件,在最下面添加以下内容:

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

上面的代码定义了两个自定义字段,一个是 “author”,用来设置文章的作者信息;另一个是 “cover”,用来设置文章的封面图片地址。如果你需要添加更多的自定义字段,只需要在 custom_fields 下面增加即可。

然后在你的 Markdown 文章文件里,就可以使用这些自定义字段了。例如:

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

在 Hexo 生成静态页面的过程中,变量 {{ page.author }} 和 {{ page.cover }} 就会被解析出来,被转换为你在 _config.yml 文件里设置的值,然后在模板中进行展示。

3. 其他使用场景

除了在文章的 front-matter 中定义自定义字段之外,hexo-custom-fields 包还支持在模板中调用自定义字段。方法如下:

首先在模板中定义一个变量:

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

然后在页面显示这个变量:

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

这样就可以轻松地实现在所有页面中显示自定义的 Meta 描述信息了。

4. 总结

hexo-custom-fields 包是一个非常方便的工具,可以帮助我们快速地定义和使用自定义字段。不仅可以用来设置文章作者、封面等信息,还可以用来设置文章摘要、Meta 描述信息等。相信在你的 Hexo 项目中使用 hexo-custom-fields 包一定会事半功倍!

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/60055a0881e8991b448d7afa


猜你喜欢

  • npm 包 cordova-plugin-firebase-native 使用教程

    介绍 cordova-plugin-firebase-native 是一个第三方插件,可以使得 Cordova 应用集成 Firebase 服务。其特别之处在于使用了 Firebase 的原生 SDK...

    2 年前
  • npm 包 correlate-patch 使用教程

    在前端开发中,我们常常需要使用到各种各样的插件和库,而 npm 就是前端开发中常用的包管理工具,它为我们提供了大量的开源库和工具,其中包括 correlate-patch。

    2 年前
  • npm包mathmodule-hnu使用教程

    npm是一个Node.js包管理器,可帮助开发者轻松查找、安装和管理各种Node.js包。在前端开发中,经常需要进行数学计算,为了实现快速、高效地处理数字和数学运算,在使用npm包的时候,我们选择了m...

    2 年前
  • npm 包 Vue-Cognito-Auth 使用教程

    Vue-Cognito-Auth 是一个基于 Vue.js 的认证模块,能够轻松实现用户注册、登录、令牌管理等功能。它集成了 Amazon Cognito,提供了可靠、安全的身份验证方式。

    2 年前
  • npm 包@rjblopes/react-native-camera 使用教程

    介绍 @rjblopes/react-native-camera 是 React Native 社区中一个非常受欢迎的相机组件。它通过 Native 模块为应用程序提供相机功能,可以让开发人员方便地在...

    2 年前
  • npm 包 google-finance2 使用教程

    npm 包 google-finance2 使用教程 在前端开发中,很多时候我们需要获取金融相关的数据。而 Google Finance 是一个广受欢迎的金融信息数据源。

    2 年前
  • npm 包 express-rpc-beeson 使用教程

    什么是 express-rpc-beeson express-rpc-beeson 是一个基于 Express 框架的 RPC(远程过程调用)库,它可以帮助开发者快速地搭建一个远程服务,并使其与前端进...

    2 年前
  • npm 包 log4js-logentries-appender 使用教程

    在前端开发中,日志记录是一项必不可少的工作。而 log4js-logentries-appender 可以使得日志记录更为方便且高效。本文将介绍 npm 包 log4js-logentries-app...

    2 年前
  • npm 包 cordova_plugin_aps_notification 使用教程

    前言 在移动应用开发中,推送通知是必不可少的功能。通过推送通知,可以及时向用户展示新消息、活动、促销等信息,提高用户参与度和留存率。而 cordova_plugin_aps_notification ...

    2 年前
  • npm 包 digo-jjencode 使用教程

    digo-jjencode 是一个可以将 JavaScript 代码进行简单混淆的 npm 包。在前端开发中,我们经常需要对代码进行加密、混淆等处理,以保护我们的代码不被恶意攻击者所使用。

    2 年前
  • npm包meteor-sfc使用教程

    在前端开发中,使用组件化开发能够大大提高开发效率,meteor-sfc(Meteor-single-file-component)是一个可以把Vue单文件组件转化成Meteor模板的npm包,在Met...

    2 年前
  • npm 包 ftp-helper 使用教程

    前言 在前端开发中,当我们需要上传或下载文件到 FTP 服务器时,往往需要使用 FTP 客户端或者使用 FTP 命令行工具。但是这些工具有以下几个缺点: 操作繁琐,需要频繁输入用户名、密码、服务器地...

    2 年前
  • npm 包 offlineh5 使用教程

    简介 offlineh5 是一个可以将 web 应用离线缓存的 npm 包。通过使用它,我们可以使我们的 web 应用变得更加快速、可靠,并且可以在网络不稳定的情况下继续使用。

    2 年前
  • npm 包 node-interface 使用教程

    在前端开发中,我们经常需要与后端进行 API 交互,这时候就需要用到 Node.js。而在 Node.js 中,使用 npm 包可以极大的提高开发效率,减少重复劳动。

    2 年前
  • npm 包 nativescript-msf 使用教程

    在前端开发中,我们经常需要使用跨平台的技术来实现不同操作系统的应用程序。而 nativescript-msf 就是一款能够实现这一功能的 npm 包。 本篇文章将会介绍 nativescript-ms...

    2 年前
  • npm 包 react-native-record 使用教程

    react-native-record 是一个 React Native 应用开发中常用的录音包,它是基于 React Native API 封装而来,具有良好的跨平台适配性和灵活性。

    2 年前
  • npm 包 le-challenge-cloudflare 使用教程

    介绍 在前端开发中,有许多工具和包供我们使用,npm 是其中之一。npm 是 Node.js 的包管理器,它可以让我们轻松地管理、安装和分享代码。本文将重点介绍 npm 包 le-challenge-...

    2 年前
  • npm 包 pre-rating 使用教程

    在前端开发过程中,我们经常需要对用户进行各种评分操作,为了方便我们的开发,有许多优秀的评分插件出现,如 Star Rating 和 RateYo,但这些评分插件往往功能较为繁琐,引入量也比较大,如果只...

    2 年前
  • npm 包 greenway-design 使用教程

    前言 在前端开发中,我们经常需要使用各种第三方工具和框架来提高效率和质量。而 npm 是前端开发者最常用的包管理器之一。在众多 npm 包中,greenway-design 是一个非常优秀的 UI 库...

    2 年前
  • npm 包 generator-vue-starter 使用教程

    简介 generator-vue-starter 是一个基于 Vue.js 的项目生成器,使用 Yeoman 和 webpack 来创建新的 Vue.js 项目。它提供了一整套的工具和框架,可以快速地...

    2 年前

相关推荐

    暂无文章