npm 包 metalsmith-pinboard 使用教程

阅读时长 4 分钟读完

前言

前端开发离不开工具和框架,npm(Node.js 包管理器)便是其中之一。而使用 npm 包来 扩展工具能力 和提高开发效率是一种常见做法。在这篇文章中,我们将介绍一个名为 metalsmith-pinboard 的 npm 包,它可以用于将 Pinboard 中的链接导入到博客中。

什么是 metalsmith-pinboard?

metalsmith-pinboard 是一个用于将 Pinboard 中的书签导入至静态网站博客的 npm 包。Pinboard 是一个收藏书签的网站,这个包可以帮助博主将自己在 Pinboard 收藏的链接导入到博客中。除此之外,metalsmith-pinboard 也可以帮助将代码片段、博客文章或其他类型的 HTML 文件导入博客。

安装 metalsmith-pinboard

在使用 metalsmith-pinboard 之前,我们需要确保已经安装 metalsmith 和 metalsmith-markdown。假设你已经安装了 metalsmith 和 metalsmith-markdown,可以直接在命令行中通过 npm 安装 metalsmith-pinboard:

如何使用

使用 metalsmith-pinboard 时,我们需要做以下几件事情:

  1. 安装 metalsmith 和 metalsmith-markdown;
  2. 在命令行中安装 metalsmith-pinboard;
  3. 在 Metalsmith 配置文件中引入 metalsmith-pinboard;
  4. 在 Metalsmith 配置文件中设置 metadata 并通过 metalsmith-in-place 插件渲染。

设置 metadata

在使用 metalsmith-pinboard 前,我们需要在项目根目录下创建一个 metalsmith 配置文件。在这个文件中,我们需要设置一些 metadata,以及一个 dest 文件夹用于存储将被导入的书签:

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

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

在这个配置文件中,我们需要设置这么几个属性:

  • username:你的 Pinboard 用户名;
  • password:你的 Pinboard 密码;
  • tag:需要导入的书签的标签名称;
  • dest:存放书签的文件夹。

需要注意的是,这里申请的是自己的 Pinboard 账号和密码,所以需要填写自己的信息。

导入书签

接下来,我们需要在项目根目录下运行:

该命令会将 Pinboard 中标记 tag-name 的书签导入到 bookmarks 文件夹中。导入的书签将使用 .md 文件格式进行保存。这个过程需要一些时间,取决于你 Pinboard 中书签数量。

渲染博客

渲染博客的部分我们使用了 metalsmith-markdown 和 metalsmith-in-place 两个插件。我们需要在这个执行顺序后面添加下面的代码:

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

其中 metadata 就在上面的部分设置了,这里就不再赘述。

结语

metalsmith-pinboard 使得博客在获取资源方面更加方便,不再需要拷贝博客中的链接到 Pinboard 上收藏,然后再一个个粘贴在博客上。它可以直接从 Pinboard 中将书签导入到博客中。除了使用这个 npm 包外,学习如何开发简单的程序就是我们渴望的目标。希望这篇文章能够帮助您更深刻地理解和使用 metalsmith-pinboard 这个 npm 包。

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

纠错
反馈