hexo脚本编写指南(一)

说明

  • 脚本可以实现所有插件可以实现的功能
  • npm插件是分享给大家用的小脚本而已
  • 脚本需要掌握hexo api 地址在此

调用

脚本(Scripts)
只需要把 JavaScript 文件放到 scripts 文件夹,在启动时就会自动载入。

最简单用法

比如我们写一个hello.js,放到scripts下,我们利用hexo.extend.helper辅助函数来写点儿东西

hexo.extend.helper.register('js', function(path){
  return '<script type="text/javascript" src="' + path + '"></script>';
});

在index.html模板中调用

<%- js('script-demo.js') %>
// <script type="text/javascript" src="script-demo.js"></script>

其实就是函数调用,很方便 很实用。

生成器(Generator) 详解

第一个小例子

第一步

让我们再创建一个js文件
/scripts/hello2.js

hexo.extend.generator.register('gen', function(locals){
    return {
      path: 'gen/index.html',
      data: locals.posts,
      layout: ['gen']
    }
  });

第二步

在主题模板里面创建一个名为gen的模板,里面随便写点儿什么

说明

以上的含义就是:

  • 当hexo g时,创建一个path为“gen/index.html”的静态文件,
  • 如果访问http://localhost:4000/gen/index.html,url就指向了这个文件
  • 这个文件的layout模板是gen
  • index.html里面的内容其实是content内容 直接引用到头尾中间

这个功能就是利用代码创建了一个页面

第二个小例子

建立有分页的一个新页面

第一步

创建新的js
/scripts/demo.js

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

hexo.extend.generator.register('demo', function(locals){
  return pagination('demo/index.html', locals.posts, {
    perPage: 3,
    layout: ['archive', 'index'],
    data: {__index:"demo"}
  });
});

第二步

创建几篇文章 我利用hexo new post 创建了5篇 post01 post02 post03 post04 post05
因为我设置了perPage为3,所以必然会分页

第三步

运行 hexo g
可以看到 静态文件已经生成 并且自动创建了分页


image.png

需要注意的是 文件夹的名字叫index.html

第四步

手动敲入 http://localhost:4000/demo/index.html/
得到的是以archive为模板的一个页面 而且分页已经生成好

image.png

需要注意的是 第二页的url为 http://localhost:4000/demo/index.html/page/2/
完全符合分页的生成规则 [base(demo/index.html)+"/"+page/d%]

第三个小例子

自动生成指定路径的页面

第一步

scripts/demo.js 再添加新代码

hexo.extend.generator.register('post', function(locals){
    return locals.posts.map(function(post){
      return {
        path: "book/"+post.path,
        data: post,
        layout: 'post'
      };
    });
  });

第二步

hexo g
这样就出现了一个book文件夹 内部的文件夹结构与post的原生结构一模一样


image.png

其实也十分好理解 因为我本身用的就是post.path

第三步

输入 http://localhost:4000/book/2019/01/12/post03/
其所有东西与 http://localhost:4000/2019/01/12/post03/一模一样
因为我用的是同一个布局和同一个data,仅仅是更换了路径而已

总结

我们知道 生成一个页面只需要返回一个包含path layout data 三项的对象即可
生成多个页面 可以返回一个包含多个页面对象的数组
通过Generator的用法 我们可以得到任意我们想要的一系列页面

更多generator说明请查看官方文档

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

推荐阅读更多精彩内容