npm 包 hexo-filter-github-issue-link 使用教程

阅读时长 4 分钟读完

介绍

hexo-filter-github-issue-link 是一个适用于 Hexo 博客系统的 npm 包,该包可以将文章中的 GitHub issues 自动转化为对应的链接。此外,该包还支持对 GitHub issues 进行编号、分类等操作,使得博客更加清晰、方便浏览。

安装

使用 hexo-filter-github-issue-link 之前需要确保已经安装了 Hexo。在终端中输入以下命令来安装 hexo-filter-github-issue-link:

使用

安装完成后,在博客配置文件中启用 hexo-filter-github-issue-link 插件:

启用插件后,即可在文章中像下面这样使用 GitHub issues:

在博客生成时,hexo-filter-github-issue-link 会将上述代码转化为以下内容:

此外,hexo-filter-github-issue-link 还支持对 issues 进行编号、分类等操作。例如:

上述代码将会被转化为:

可以看到,上述代码通过添加 class 名称来对 issue 进行 categorize。此外,hexo-filter-github-issue-link 还支持添加标签样式以及自定义输出格式等功能,具体实现可以查看官方文档。

示例代码

下面是一个使用 hexo-filter-github-issue-link 的示例代码。该代码演示了如何在文章中使用 GitHub issuess,并给出了一些可以调整的选项:

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

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

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

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

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

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

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

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

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

上述代码中,我们使用了多种不同的 GitHub issues,包括单纯的链接、编号时带有 categorize、指向 Pull Request 的链接等等。此外,我们还通过在博客末尾添加 #issues-123 来创建一个本文的问题列表。最后,我们使用了 hexo-filter-github-issue-link 的一个自定义格式,将上述 issues 以一种特定的格式输出。

总结

在本文中,我们讲解了如何使用 npm 包 hexo-filter-github-issue-link,将 GitHub issues 链接自动化地添加到博客文章中。通过学习本文,我们可以更好地进行博客编写,使得博客更加完善、易读,同时也为我们的学习以及指导意义提供了极大的帮助和便利。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60056d1281e8991b448e6d15

纠错
反馈