npm包 wintersmith-categorizer: 使用教程

如果你经常使用静态网站生成器Wintersmith,你可能会遇到需要对文章进行分类的情况。这时候,一个名为wintersmith-categorizer的npm包可能能给你提供帮助。这篇文章将详细介绍npm包wintersmith-categorizer的使用方法,希望对你有所帮助。

简介

wintersmith-categorizer是一个Wintersmith插件,它可以将文章按照声明的分类整理到各自的目录中。此外,它还可以生成一个网站分类索引页面。

安装

使用npm进行安装:

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

使用

  1. 在你的Wintersmith项目的config文件中添加该插件:
-
  ---------- -
    -------------------------
  -
-
  1. 在你的文章的metadata中声明分类信息:
---
------ -- ---- ----
--------- ------------
--------- -----------
----- ----------- -------
---

在metadata中,添加了"classify"属性的value即是该文章所属的类别。该属性值可以是一个字符或是包含标点符号/空格的字符串。

3.(可选)你可以在你的jade templage中添加链接到分类索引页面的链接:

--
  --
    -------------------------------------- -----------
  1. 生成静态网站:
- ----------- -----

在执行完build命令后,你会发现生成了一个名为“categories”的文件夹,其中包含分类目录和分类索引页面。所有文章按照分类分配到各自的分类目录中。你可以通过访问“yourwebsite.com/categories/programming.html”来查看programming类别的文章。

参数

wintersmith-categorizer插件提供了几个可配置参数:

  • output:用于存储分类目录的文件夹名称,默认为"categories"
  • indexTemplate:分类索引页面的模板名称,默认为"categoryIndex.jade"
  • categoryTemplate:分类目录中页面的模板名称,默认为"category.jade"

你可以在你的config.json文件中添加以下代码,然后更改对应的参数来修改插件的默认设置:

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

示例代码

下面是一个完整的静态网页生成代码:

Article.md

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

_tpl/category.jade

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

_tpl/categoryIndex.jade

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

config.json

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

在运行完上述代码后,你会在youwebsite.com/categories中看到静态网页,其中含有"programming"分类的文章。这个示例完整的实现了wintersmith-categorizer的使用,并可以作为你实现该插件的参考。

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


猜你喜欢

  • npm 包 wppm 使用教程

    wppm 是一个用于在前端开发中自动化完成项目构建、管理依赖、打包发布等任务的 npm 包,其简化了前端重复劳动、提高了工作效率。在本文中,我们将详细介绍如何使用 wppm 进行前端开发中的自动化工作...

    4 年前
  • npm 包 wprestjs 使用教程

    在现代Web开发中,许多前端开发者会从CMS中获取数据。WordPress是一款非常流行的CMS之一,它可以通过REST API向外部提供数据。为了让前端开发更加方便,就有了 npm 包 wprest...

    4 年前
  • npm 包 wps 使用教程

    背景 WPS Office 是一套非常流行的办公软件,与 Microsoft Office 类似,但是有着比 Microsoft Office 更为友好的价格和跨平台的特性。

    4 年前
  • npm 包 wpscan 使用教程

    作为一名前端开发者,我们常常需要保证我们的网站的安全性。其中,一个非常重要的措施就是对其进行漏洞扫描。wpscan 是一个非常常见的漏洞扫描工具,也是我们推荐使用的一款 npm 包,具有简单易用,功能...

    4 年前
  • npm包wx-tips使用教程

    前言 在开发前端项目中,我们难免会遇到需要在页面中使用弹窗、提示框等功能的情况。而wx-tips就是一个可以很好地解决这一问题的npm包。在本篇文章中,我们将详细介绍该包的使用方法及其深度和指导意义。

    4 年前
  • npm 包 wpscholar-gulp-task-browserify 使用教程

    前言:在前端开发中,我们经常使用到“打包工具”来优化我们的开发流程。其中,gulp 作为一种流式构建工具,被广泛应用于前端开发中,而 npm 则是我们在管理依赖,发布包以及使用其它开发者的代码时必不可...

    4 年前
  • npm 包 ws-socket-api 使用教程

    在现代 Web 应用中,WebSocket 是通信技术的一种重要选择。ws-socket-api 是基于 Node.js 实现的 WebSocket 库,它提供了一种简单方便的方式来实现 WebSoc...

    4 年前
  • npm 包 wx-login 使用教程

    简介 wx-login 是一款基于 Node.js 平台的 npm 包,用于实现微信公众号网站的授权登陆功能。该包提供了简洁、高效、易用、兼容性强的接口,能够帮助开发者快速实现微信授权登陆。

    4 年前
  • NPM 包 wx-rest 使用教程

    前言 随着微信小程序的普及,越来越多的前端开发者开始关注微信小程序的开发。使用微信小程序进行开发需要使用到一些特殊的 API 和工具,而其中一个重要的工具就是 wx-request 包。

    4 年前
  • npm 包 work.flow 使用教程

    什么是 work.flow work.flow 是一个专门针对前端工程化流程优化的 npm 包。它通过简化代码中的重复性操作,提升前端开发效率,规范前端开发流程,进一步提高项目的可维护性。

    4 年前
  • npm包wx-qrcode使用教程

    概述 wx-qrcode是一个基于Node.js的npm包,可以方便快捷地生成二维码并在微信公众号中使用。使用该npm包可以极大地提高前端工程师的开发效率,让开发过程更加便捷。

    4 年前
  • npm 包 wpk-manager 使用教程

    前言 在前端开发中,构建工具已经成为我们必不可少的一部分。其中,webpack 被广泛应用于现代 JavaScript 应用的构建中。虽然 webpack 的配置可定制化的内容很多,但有时候我们需要快...

    4 年前
  • npm 包 wx-qrcode 使用教程

    前言 在前端开发中,生成二维码是一项常见的需求。在过去,如果想要生成二维码,我们需要手动编写一些实现逻辑,这不仅费时费力,而且容易出错。但是现在,我们可以使用一些优秀的 npm 包来轻松实现这个功能。

    4 年前
  • npm 包 worker-as-a-promise 使用教程

    在前端开发过程中,如果需要执行一些比较耗时的任务,如大量的数据计算、图片处理等,不可避免地会占用主线程。这不仅会降低用户体验,还可能导致页面卡顿、崩溃等问题。为了解决这个问题,我们可以使用 JavaS...

    4 年前
  • npm 包 work-xingzhe 使用教程

    简介 work-xingzhe 是一个基于工作小时打卡记录的 npm 包。它可以帮助你记录你的工作小时,并随时查看你的打卡记录。 安装 在终端中使用以下命令来安装 work-xingzhe: --- ...

    4 年前
  • npm 包 wpilib 使用教程

    前言 wpilib 是一个开源的、用于编写 FRC 机器人程序的库,其中包含了大量与机器人控制器交互的函数和类。随着机器人比赛的兴起,其得到了越来越多开发者的关注和使用。

    4 年前
  • npm 包 work-q 使用教程

    npm 包 work-q 使用教程 在前端开发中,经常需要进行异步操作,为了优化异步操作,减少回调函数嵌套,我们可以使用消息队列来处理异步操作。npm 包 work-q 就是一款轻量级的消息队列工具,...

    4 年前
  • npm 包 ws-without-native 使用教程

    WebSocket(简称WS)是一种在Web浏览器和服务器之间进行双向实时通信的技术。通常在前端开发中,我们使用WebSocket来实现实时通信,如聊天室、实时数据更新等。

    4 年前
  • npm包worker-ci使用教程

    概述 worker-ci是一款基于Node.js的自动化构建工具,可以让前端开发者在开发流程中更高效,更轻松地进行持续集成和部署。通过自动从代码仓库拉取代码、运行构建脚本、收集构建报告和部署至服务器等...

    4 年前
  • npm 包 ws-yummly 使用教程

    什么是 ws-yummly ws-yummly 是基于 Node.js 的一个 npm 包,它提供了一个 API,用于从 Yummly 网站上获取美食菜谱信息。Yummly 是一个美食社交网站,用户可...

    4 年前

相关推荐

    暂无文章