npm 包 - metalsmith-simple-excerpt 使用教程

AI 编程助手,豆包旗下的编程助手,提供智能补全、智能预测、智能问答等能力,节省开发时间,释放脑海中的创造力,支持 VSCode,点击体验 AI

Metalsmith 是一款强大的静态网站生成器,可以通过它来搭建自己的博客,静态网页等。而 metalsmith-simple-excerpt 插件则是在生成文章列表时,自动生成文章的摘要,省去了手动编写摘要的步骤,极大提升了 web 开发的速度。

安装metalsmith-simple-excerpt

要使用 metalsmith-simple-excerpt 插件,首先需要在本地安装和项目的依赖中添加 metalsmith-simple-excerpt 。可以通过命令行执行以下命令完成安装:

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

或者在项目的 package.json 文件中添加以下代码,然后执行 npm install 命令:

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

在 metalsmith.js 中配置 Excerpt 插件

安装完 metalsmith-simple-excerpt 插件之后,在项目的 metalsmith.js 配置文件中添加以下代码:

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

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

其中,length 参数表示指定摘要长度,stripTags 参数表示是否去除 HTML 标签。

在模板文件中使用 Excerpt 插件

在模板文件中使用 Excerpt 插件可以轻松的实现文章列表和文章正文中的摘要内容,以下是一个例子:

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

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

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

-------

其中,{{excerpt}} 表示文章的摘要内容。

演示

最后,我们来看一个完整的演示:

添加一个 test.md 文章:

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

- -----

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

然后在 metalsmith.js 配置文件中添加以下代码:

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

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

这里设置摘要长度为 50,于是生成的 HTML 文件中,test.html 文件的内容会变成这个样子:

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

可以看到,这里自动生成了 test.html 文章的摘要,省去了手动编写摘要的烦恼。

总结

Metalsmith-Simple-Excerpt 插件可以帮助开发者快速生成文章列表中的摘要,省去了手动编写摘要的步骤,适用于需要频繁发布文章的项目中,大大提高了生产力。建议开发者仔细学习其配置方法,从而提高自己的前端开发效率。

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


猜你喜欢

  • npm 包 mi6 使用教程

    简介 mi6 是一个能够自动生成前端项目结构和基础代码的 npm 包。它可以根据项目类型和配置信息,在几秒钟内生成包含基础模板代码的项目结构。 在本篇文章中,我们将会深入探讨 mi6 的使用方法,并且...

    4 年前
  • npm 包 mia.js 使用教程

    简介 mia.js 是一个基于 React 开发的 UI 组件库,它包含了常用的组件,如按钮、表单、弹窗等,并且具有可定制性。这篇文章将介绍如何使用 npm 包 mia.js。

    4 年前
  • npm 包 miao 使用教程

    介绍 在前端开发中,我们经常需要使用到一些公共的 JavaScript 模块。npm(Node Package Manager)就是一个管理这些模块的工具。而 miao 就是这些模块中的一种,它是一个...

    4 年前
  • npm 包 micromarkdown 使用教程

    前言 在前端开发中,Markdown 已经成为了一种常见的文档标记语言,它在文档写作、博客发布、项目说明等方面应用广泛。然而,在一些特定的场景下,我们需要将 Markdown 转化为 HTML。

    4 年前
  • npm 包 micrometrics-sdk 使用教程

    介绍 Micrometrics 是一个非常实用的前端性能监控工具,可以帮助前端开发人员实时监测网站的加载速度、页面渲染时间以及资源加载情况。Micrometrics 通过记录页面上的一些关键点,例如 ...

    4 年前
  • npm 包 micromix 使用教程

    在前端开发中,经常需要实现音频播放、音频剪辑等功能,而 micromix 就是一个可以一次性实现这些功能的 npm 包。本文将为您介绍如何使用 micromix,让您在开发中实现优秀的音频效果。

    4 年前
  • npm 包 micromonitor 使用教程

    随着前端开发的不断发展,负责监控网站性能和异常的工具变得越来越重要。npm 包 micromonitor 是一款针对前端性能监控的工具,可以帮助开发者监测网站的各种性能指标,并及时发现并解决问题。

    4 年前
  • 前端技术文章:mi-aqara-sdk 使用教程

    简介 mi-aqara-sdk 是一个基于 Node.js 的 npm 包,提供了连接小米网关与 Apple HomeKit 框架之间的 API。想象一下,您可以通过 Siri 或 Apple 的家庭...

    4 年前
  • npm 包 microlibrary-pujan 使用教程

    npm 是 JavaScript 包管理器,通过 npm 可以安装第三方模块,让开发变得更加高效。microlibrary-pujan 是一个小型库,用于处理 DOM 操作,本文将介绍如何使用它。

    4 年前
  • npm 包 microlink-cli 使用教程

    近年来,前端领域迅猛发展,各种工具也层出不穷。其中,npm 包可以说是前端必不可少的一部分。而 microlink-cli 就是一款十分实用的 npm 包,它可以让你快速地将任何一个链接转换成一个美观...

    4 年前
  • NPM包microlight-string使用教程

    一、microlight-string简介 microlight-string是一款可以快速进行代码高亮的npm包。它专门针对于前端开发的字符串进行了优化,以最小的体积提供了代码高亮的核心功能,并具有...

    4 年前
  • npm 包 migrate-semver 使用教程

    简介 在前端开发中,我们常常会用到 npm 包。其中有一个很常见的需求是需要对 npm 包的版本进行管理和更新。而在版本管理中,Semantic Versioning(语义化版本控制)成为了大多数 n...

    4 年前
  • npm 包 micromono 使用教程

    在前端开发中,npm 是一个非常重要的工具,它可以帮助我们管理和共享代码包。micromono 是一个基于 npm 的微服务框架,它提供了一种简单的方式来开发和部署微服务应用程序。

    4 年前
  • npm 包 migre-me-url 使用教程

    在前端开发中,获取 URL 地址是一项非常基础且常见的操作,我们可以使用原生的 JavaScript 编写代码实现,也可以使用第三方库。其中,npm 包 migre-me-url 是一个轻量且易于使用...

    4 年前
  • npm 包 migrit 使用教程

    简介 migrit 是一个轻量级的数据库迁移工具,专门用于管理数据库模式和数据迁移。 migrit 的主要特点: 简单易用,只需一行代码即可快速集成到项目中 支持多种数据库,包括 MySQL、Pos...

    4 年前
  • npm 包 migromongo 使用教程

    什么是 migromongo migromongo 是一个 Node.js 模块,用于将 Migrate 数据库迁移框架与 MongoDB 数据库集成在一起。MongoDB 是当前最受欢迎的 NoSQ...

    4 年前
  • npm包migroose使用教程

    什么是migroose migroose是一个基于mongoose ORM的简单易用的数据库迁移工具。借助migroose,我们可以方便地对数据库进行升级和回滚。sql语言由于其语言上的限制,难免会出...

    4 年前
  • npm 包 mexbt 使用教程

    什么是 mexbt mexbt 是一个 npm 包,它提供了一个与 Mexbx API 交互的方法,Mexbx 是一个数字资产交易平台,它允许用户在 crypto 与 fiat 之间进行交易。

    4 年前
  • npm 包 migroose-cli 使用教程

    介绍 migroose-cli 是一个使用 Node.js 开发的命令行工具,专门用于快速创建和管理 Mongoose 数据库迁移脚本。Mongoose 是 Node.js 中最流行的 ODM 库之一...

    4 年前
  • npm 包 `mextend` 使用教程

    mextend 是一个开源的 Node.js 模块,提供了一些有用的通用方法和工具函数,适用于前端开发。本文将介绍 mextend 的使用,包括其安装、常用方法以及实际应用场景。

    4 年前

相关推荐

    暂无文章