hexo-generator-index 源码分析

相关文章 请按顺序阅读
hexo-pagination函数释义
hexo-generator-index 源码分析
hexo-generator-tag 源码分析

源码地址

前言:
hexo-generator-index是hexo插件中应该是最简单的一个插件了

官方hexo自3.0以后就自带此插件了
但是官方的doc文档源码中,是未用此插件的
\color{red}{如果没有用此插件,那么所有的页面都是默认用post模板,包括index页面}
post模板只能显示post页面变量
而下列变量一概没有

page.per_page   每页显示的文章数量
page.total  总页数
page.current    目前页数
page.current_url    目前分页的网址
page.posts  本页文章
page.prev   上一页的页数。如果此页是第一页的话则为 0。
page.prev_link  上一页的网址。如果此页是第一页的话则为 ''。
page.next   下一页的页数。如果此页是最后一页的话则为 0。
page.next_link  下一页的网址。如果此页是最后一页的话则为 ''。
page.path   当前页面的路径(不含根目录)。我们通常在主题中使用 url_for(page.path)。

以上变量只有在index页面才有

而hexo-generator-index解决的问题就是把以上变量带入到模板中 形成index页面

'use strict';

const pagination = require('hexo-pagination');

module.exports = function(locals) {
  const config = this.config;
  const posts = locals.posts.sort(config.index_generator.order_by); //所有文章
  const paginationDir = config.pagination_dir || 'page';//pagination_dir: page #分页文件夹名称
  const path = config.index_generator.path || ''; //路径 缺省为空 

  return pagination(path, posts, {
    perPage: config.index_generator.per_page, //找的是 _config.yml里面index_generator的per_page
    layout: ['index', 'archive'],
    format: paginationDir + '/%d/',
    data: {
      __index: true
    }
  });
};
  1. 首先要了解hexo-pagination这个内部工具
    pagination(base, posts, [options])
    地址在这里
    2 通过这个函数 我们知道我们可以用的变量为
    this.config:_config.yml里面所有的值
    locals:包含下列值
变量 描述
posts 所有文章
pages 所有分页
categories 所有分类
tags 所有标签

3 调用方式为:


image.png

其实都是pagination的返回值而已

4 通过这个插件我们可以学到:
它仅仅指定了分页对象需要打到哪个路径上,然后通过page变量调取

举例:
一共创建4篇文章
修改config,每页3篇文章 这样就有了两页
在index.ejs中,写如下代码

 current:<%= page.current %><br />
 <% page.posts.each(function(post){ %>
    <%= post.title %>
  <% }) %><br />
 current-url:<%= page.current_url %>
 total: <%= page.total %><br />
 next: <%= page.next %><br />
 next_link: <%= page.next_link %><br />
 pre: <%= page.pre %><br />
 pre_link: <%= page.pre_link %><br />
 __index: <%= page.__index %><br />
 per_page: <%= page.per_page %><br />
 path: <%= page.path %><br />

在前端显示如下:
http://localhost:4000/

current:1
hh gg asdf 
current-url: total: 2
next: 2
next_link: page/2/
pre: 
pre_link: 
__index: true
per_page: 
path: index.html

http://localhost:4000/page/2/

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