Hexo站点中添加文章目录以及归档

通过前面的介绍,Hexo站点的布局应该了解得差不多了,这次主要介绍一下如何使用Hexo自带的帮助函数在站点中添加归档以及文章目录。添加这两块功能都是使用了Hexo提供的帮助函数,创建对应局部模块之前,首先要想想这两块内容应该属于哪个布局?要添加到哪个局部模块下?考虑这些是为了整洁性,当你添加的东西越来越多的时候才不至于令自己混乱。

一、文章目录

文章目录肯定是添加到post布局上,这个毋庸置疑,因为只有看文章详情页的时候才需要目录。那么我们在目录layout/_partial/post/下创建toc.ejs文件,代码如下:

<div id="toc" class="toc-article">
    <div class="toc-title">目录</div>
    <%- toc(item.content, {list_number: false}) %>
</div>

这里使用了Hexo提供的toc()帮助函数,它的使用方法如下:

<%- toc(str, [options]) %>

str就是文章内容,options有两个参数,一个是class,也就是html标签的class值,默认为toc;一个是list_number,是否显示列表编号,默认值是true。

接下考虑把这个局部模块放到哪呢,既然属于post布局,那么就看看layout/post.ejs代码如下:

<%- partial('_partial/article', {item: page, index: false}) %>

很明显,我们要到_partial/article.ejs文件里添加toc.ejs,添加后article.ejs代码如下:

......
    <div class="entry">
      <% if (item.excerpt && index){ %>   <!--01-->
        <%- item.excerpt %>
      <% } else { if (item.toc !== false) {%>   <!--02-->
        <%- partial('post/toc') %>
      <% } %>
        <%- item.content %>
      <% } %>
    </div>
......

01、判断是否有摘要以及index值,显然post.ejs传过来的index值为false;
02、接下来判断page.toc是不是不等于false,这一块的主要作用是可以在文章的前置声明里设置toc: false来关闭目录功能。当没有设置false时,插入上面写的toc.ejs局部模块。

OK!完美嵌入进去,接下来就是设置样式了,进入source/css/_partial/目录下,创建toc.styl,代码这里就不贴出了,具体查看github。最后别忘了在source/css/style.styl文件里加入这句了@import '_partial/toc'。显示如下图,样式可以自行调整。

toc01.jpg

二、归档sidebar

默认的hexo-theme-light主题没有添加归档的sidebar挂件,于是我将该widget添加到了主题light-ch中。先看一下效果如下图:

archive01.png

sidebar中的局部模块都在layout/_widget中,于是在该文件夹下创建archive.ejs,代码如下:

<% if (site.posts.length){ %>
  <div class="widget tag">
    <h3 class="title">归档</h3>
    <%- list_archives({format: "YYYY年MM月"}) %>
  </div>
<% } %>

然后在主题的配置文件中_config.yml中加入该widget,如下所示:

widgets:
    - category
    - archive
    - tagcloud
    - weibo

最后就是设置样式了,在source/css/_partial/sidebar.styl文件中加入了这么一段就能如上显示了。

.archive-list
    font-size 0.9em
    padding 15px 20px 
    .archive-list-count
        margin-left 8px
        font-size 0.8em
        color color-meta
        &:before
            content '('
        &:after
            content ')'

这段样式是为了和分类列表保持一致。详细代码参照github来自定义样式。

总结

这里通过添加文章目录以及归档侧边栏的实战练习,大致了解了如何在Hexo站点中添加局部模块和widget,基本上也就这两种类型。
诸如添加百度统计、多说评论以及微博小插件等等,都可以归属为上述两类,这里就不再赘述,详情可以参照github上代码,有什么问题可以随时向我提issue。

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

推荐阅读更多精彩内容