这次主要介绍一下如何使用Hexo自带的帮助函数在站点中添加文章目录。功能使用了Hexo提供的帮助函数,创建对应局部模块之前,首先要想想这块内容应该属于哪个布局?要添加到哪个局部模块下?考虑这些是为了整洁性,当你添加的东西越来越多的时候才不至于令自己混乱。
文章目录
文章目录肯定是添加到post
布局上,这个毋庸置疑,因为只有看文章详情页的时候才需要目录。那么我们在目录layout/_partial/post/
下创建toc.ejs
文件,代码如下:
1 | <div id="toc" class="toc-article"> |
这里使用了Hexo提供的toc()
帮助函数,它的使用方法如下:
1 | <%- toc(str, [options]) %> |
str
就是文章内容,options
有两个参数,一个是class
,也就是html
标签的class
值,默认为toc
;一个是list_number
,是否显示列表编号,默认值是true
。
接下考虑把这个局部模块放到哪呢,既然属于post
布局,那么就看看layout/post.ejs
代码如下:
1 | <%- partial('_partial/article', {item: page, index: false}) %> |
很明显,我们要到_partial/article.ejs
文件里添加toc.ejs
,添加后article.ejs
代码如下:
1 | <div class="article-entry" itemprop="articleBody"> |
判断是否有摘要以及
index
值,显然post.ejs
传过来的index
值为false
;接下来判断
page.toc
是不是不等于false
,这一块的主要作用是可以在文章的前置声明里设置toc: false
来关闭目录功能。当没有设置false
时,插入上面写的toc.ejs
局部模块。
OK!完美嵌入进去,接下来就是设置样式了,进入source/css/_partial/
目录下,创建toc.styl
.最后别忘了在source/css/style.styl
文件里加入这句了@import '_partial/toc'
。显示如下图,样式可以自行调整。
toc.styl
1 | .toc-article { |
效果如图