Metalsmith 是一款强大的静态网站生成器,可以通过它来搭建自己的博客,静态网页等。而 metalsmith-simple-excerpt 插件则是在生成文章列表时,自动生成文章的摘要,省去了手动编写摘要的步骤,极大提升了 web 开发的速度。
安装metalsmith-simple-excerpt
要使用 metalsmith-simple-excerpt 插件,首先需要在本地安装和项目的依赖中添加 metalsmith-simple-excerpt 。可以通过命令行执行以下命令完成安装:
npm install metalsmith-simple-excerpt --save
或者在项目的 package.json 文件中添加以下代码,然后执行 npm install 命令:
"dependencies": { "metalsmith-simple-excerpt": "version" }
在 metalsmith.js 中配置 Excerpt 插件
安装完 metalsmith-simple-excerpt 插件之后,在项目的 metalsmith.js 配置文件中添加以下代码:
const excerpt = require('metalsmith-simple-excerpt'); metalsmith.use(excerpt({ length: length, // 指定摘要长度 stripTags: stripTags // 是否去掉 HTML 标签 }));
其中,length 参数表示指定摘要长度,stripTags 参数表示是否去除 HTML 标签。
在模板文件中使用 Excerpt 插件
在模板文件中使用 Excerpt 插件可以轻松的实现文章列表和文章正文中的摘要内容,以下是一个例子:
-- -------------------- ---- ------- --------- ----- ----- ------------- ------ ----- ---------------- ------------------- ------- ------ ------- ------------------ ---- ------------- --- --------------------- --------------------------------- ---- ----------------------------------- ------ --------- ------- -------
其中,{{excerpt}} 表示文章的摘要内容。
演示
最后,我们来看一个完整的演示:
添加一个 test.md 文章:
--- title: Test date: 2021-10-21 --- # Title This is a test article.
然后在 metalsmith.js 配置文件中添加以下代码:
-- -------------------- ---- ------- ----- ---------- - ---------------------- ----- ------- - ------------------------------------- --------------------- -------------- -- ------ --------- -------------------- -- ------ --------- --------------------- ----- --------------- ----- - -- ----- ----- ---- ---
这里设置摘要长度为 50,于是生成的 HTML 文件中,test.html 文件的内容会变成这个样子:
<div class="post"> <h1 class="post-title"><a href="test.html">Test</a></h1> <div class="post-body"><p>This is a test article.</p></div> </div>
可以看到,这里自动生成了 test.html 文章的摘要,省去了手动编写摘要的烦恼。
总结
Metalsmith-Simple-Excerpt 插件可以帮助开发者快速生成文章列表中的摘要,省去了手动编写摘要的步骤,适用于需要频繁发布文章的项目中,大大提高了生产力。建议开发者仔细学习其配置方法,从而提高自己的前端开发效率。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60066f411d8e776d08040d93