hexo-next-主题构建首页动态更新目录

1 问题及需求

问题

  • 首页(home)默认显示按日期排序的文章列表,使用 `` 省略内容仍显得繁杂冗长;
  • 分类(categories)页面虽然有按类型、日期排序的文章列表,但切换分类需要往返多次。

需求

  • 建立一个首页目录,将文章分类(categories 参数)和标题,分别作为列表的一级、二级显示;
  • 标题即为文章链接,点击可直接到达;想查看其他分类,直接回到首页即可。

2 解决方案

2.1 建立文件

source/ 下建立 index.md,命名标题,内容留空。

2.2 关闭默认首页

修改 hexo 配置文件 _config.yml,找到 index_generator 配置项,修改 path 属性为一个无效值:

index_generator:
  path: 'xxxx'
  per_page: 10
  order_by: -date

此时启动项目后,首页将不再出现文章列表,转而显示 index.md 内容。

注:index.md 在渲染后成为 index.html

3 动态更新目录

若文章分类多,每次更新、调整文章都需要将相应链接手工同步到首页也是一件相当繁琐的事情。因此有必要考虑自动更新首页。

3.1 hexo 加载顺序

根据 hexo 文档 https://hexo.io/zh-cn/api/posts#%E6%B8%B2%E6%9F%93 关于渲染顺序的说明,要实现 index.md 的写入,要在 hexo g 命令执行之前完成,可引入 before_post_render 过滤器实现该需求。

3.2 hexo 过滤器

过滤器文档:https://hexo.io/zh-cn/api/filter#%E6%A6%82%E8%A6%81

在主题目录下 themes\next\filters\ 新建 index.js,添加 priority 分别为 9 和 10 的两个 before_post_render 过滤器,如下所示:

'use strict'

const categoriesMap = new Map();

hexo.extend.filter.register('before_post_render', data => {

    // 首页目录不显示草稿内容
    if (data.source.indexOf("_drafts") >= 0) {
        return data;
    }

    if (data.path.indexOf("index") < 0 && data.categories.length > 0) {

        let curCategorie = data.categories.data[0].name;

        if (categoriesMap.has(curCategorie)) {
            let valueArray = categoriesMap.get(curCategorie);
            valueArray = valueArray.concat(`  - [${data.title}](/${data.path})\n`)
            categoriesMap.set(curCategorie, valueArray);
        } else {
            categoriesMap.set(curCategorie, [`  - [${data.title}](/${data.path})\n`]);
        }
    }
    return data;
}, 9);

hexo.extend.filter.register('before_post_render', data => {
    // 精确定位index.html,防止误写其他路径不同但同名的文件
    if (data.path.indexOf("index") === 0) {

        for (let key of categoriesMap.keys()) {
            data.content += `- ${key}\n`
            let valueArray = categoriesMap.get(key);
            valueArray.forEach(element => {
                data.content += element;
            });
        }
        return data;
    }
    return data;
}, 10);

代码说明

  • 第一个过滤器遍历全部文章,获取所有现存的分类及所属文章链接;
  • 第二个过滤器写入 index.html

3.3 有关属性

为探究 data 为何物,可打断点观察其结构:

{
  title: "DataGrip-2018.3.4-数据导出配置案例",
  date: {……文章生成日期的有关参数(略)},
  _content: "……正文内容(略)",
  source: "_posts/DataGrip-2018-3-4-数据导出配置案例.md",
  raw: "……正文内容(略)",
  slug: "DataGrip-2018-3-4-数据导出配置案例",
  published: true,
  updated: {……文章更新日期的有关参数(略)},
  comments: true,
  layout: "post",
  photos: [
  ],
  link: "",
  _id: "cljzhnjmb001oz0u6en5ab6xb",
  path: "2022/12/07/DataGrip-2018-3-4-数据导出配置案例/",
  permalink: "http://www.dcheng.site/2022/12/07/DataGrip-2018-3-4-%E6%95%B0%E6%8D%AE%E5%AF%BC%E5%87%BA%E9%85%8D%E7%BD%AE%E6%A1%88%E4%BE%8B/",
  full_source: "C:\\mainProjects\\blog\\source\\_posts\\DataGrip-2018-3-4-数据导出配置案例.md",
  asset_dir: "C:\\mainProjects\\blog\\source\\_posts\\DataGrip-2018-3-4-数据导出配置案例\\",
  tags: {
    data: [
      {
        name: "DataGrip",
        _id: "cljzhnjmc001uz0u6hlov172o",
        slug: "DataGrip",
        path: "tags/DataGrip/",
        permalink: "http://www.dcheng.site/tags/DataGrip/",
        posts: {
          data: [
          ],
          length: 0,
        },
        length: 0,
      },
    ],
    length: 1,
  },
  categories: {
    data: [
      {
        name: "配置案例",
        _id: "cljzhnjmc001tz0u6967u3bji",
        slug: "配置案例",
        path: "categories/配置案例/",
        permalink: "http://www.dcheng.site/categories/%E9%85%8D%E7%BD%AE%E6%A1%88%E4%BE%8B/",
        posts: {
          data: [
          ],
          length: 0,
        },
        length: 0,
      },
    ],
    length: 1,
  },
  content: "……正文内容(略)",
  site: {
    data: {
    },
  },
}

4 最终效果

图1-默认效果.png
图2-动态目录效果.png
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,126评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,254评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,445评论 0 341
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,185评论 1 278
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,178评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,970评论 1 284
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,276评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,927评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,400评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,883评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,997评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,646评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,213评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,204评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,423评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,423评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,722评论 2 345

推荐阅读更多精彩内容