51工具盒子

依楼听风雨
笑看云卷云舒,淡观潮起潮落

Hexo Front-Matter介绍

引言 {#引言}

Front-matter 是 markdown 文件最上方以 --- 分隔的区域,用于指定当前文章的参数。

  • Page Front-matter 用于单独页面配置
  • Post Front-matter 用于文章页配置

Hexo Page Front-matter 选项详解 {#Hexo-Page-Front-matter-选项详解}

可以配置的参数如下所示:

|---------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------| | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | --- title: date: updated: type: comments: description: keywords: top_img: mathjax: katex: aside: aplayer: highlight_shrink: --- |

| 配置选项参数名称 | 默认值 | 配置选项参数说明 | |------------------|-------|-----------------------------------------------------------| | title | | 【必需】页面标题 | | date | | 【必需】页面创建日期 | | type | | 【必需】标签、分类和友情链接三个页面需要配置 | | updated | | 【可选】页面更新日期 | | description | | 【可选】页面描述 | | keywords | | 【可选】页面关键字 | | comments | true | 【可选】显示页面评论模块(默认 true) | | top_img | false | 【可选】页面顶部图片 | | mathjax | false | 【可选】显示mathjax(当设置mathjax的per_page: false时,才需要配置,默认 false) | | katex | false | 【可选】显示katex(当设置katex的per_page: false时,才需要配置,默认 false) | | aside | true | 【可选】显示侧边栏 (默认 true) | | aplayer | | 【可选】在需要的页面加载aplayer的js和css | | highlight_shrink | | 【可选】配置代码框是否展开(true/false)(默认为设置中highlight_shrink的配置) |

Front-matter 选项中的所有内容均为非必填的。建议至少填写 title 和 date 的值。

Hexo Post Front-Matter 选项详解 {#Hexo-Post-Front-Matter-选项详解}

|---------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 | --- title: date: updated: tags: categories: keywords: description: top_img: comments: cover: toc: toc_number: toc_style_simple: copyright: copyright_author: copyright_author_href: copyright_url: copyright_info: mathjax: katex: aplayer: highlight_shrink: aside: --- |

| 配置选项参数名称 | 默认值 | 配置选项参数说明 | |-----------------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------| | title | Markdown 的文件标题 | 【必需】文章标题,强烈建议填写此选项 | | date | 文件创建时的日期时间 | 【必需】文章创建日期,强烈建议填写此选项,且最好保证全局唯一 | | updated | 文件更新时的日期时间 | 【可选】文章更新日期 | | tags | 无 | 【可选】文章标签,一篇文章可以多个标签 | | categories | 无 | 【可选】文章分类,本主题的分类表示宏观上大的分类,只建议一篇文章一个分类 | | keywords | 文章关键字 | 【可选】文章关键字,SEO 时需要 | | description | 文章描述 | 【可选】文章描述 | | top_img | 无 | 【可选】文章顶部图片,推荐使用图床(腾讯云、七牛云、又拍云等)来做图片的路径。如: http://xxx.com/xxx.jpg | | cover | false | 【可选】文章缩略图(如果没有设置top_img,文章页顶部将显示缩略图,可设为false/图片地址/留空),v1.0.2版本新增,表示该文章是否需要加入到首页轮播封面中 | | comments | true | 【可选】显示文章评论模块(默认 true) | | toc | toc的enable配置 | 【可选】显示文章TOC(默认为设置中toc的enable配置) permalink_defaults:是否开启 TOC,可以针对某篇文章单独关闭 TOC 的功能。前提是在主题的 config.yml 中激活了 toc 选项 | | toc_number | toc的number配置 | 【可选】显示toc_number(默认为设置中toc的number配置) | | toc_style_simple | | 【可选】显示 toc 简洁模式 | | copyright | true | 【可选】显示文章版权模块(默认为设置中post_copyright的enable配置) | | copyright_author | | 【可选】文章版权模块的文章作者 | | copyright_author_href | | 【可选】文章版权模块的文章作者链接 | | copyright_url | | 【可选】文章版权模块的文章连结链接 | | copyright_info | | 【可选】文章版权模块的版权声明文字 | | mathjax | false | 【可选】显示mathjax(当设置mathjax的per_page: false时,才需要配置,默认 false) urlname: index 是否开启数学公式支持 ,本文章是否开启 mathjax,且需要在主题的 _config.yml 文件中也需要开启才行 | | katex | false | 【可选】显示katex(当设置katex的per_page: false时,才需要配置,默认 false) | | aplayer | 无 | 【可选】在需要的页面加载aplayer的js和css,请参考文章下面的音乐 配置 | | highlight_shrink | | 【可选】配置代码框是否展开(true/false)(默认为设置中highlight_shrink的配置) | | aside | true | 【可选】显示侧边栏 (默认 true) |

Front-matter 选项中的所有内容均为非必填的。建议至少填写 title 和 date 的值。

注意:

如果 top_img 属性不填写的话,文章特色图会根据文章标题的 hashcode 的值取余,然后选取主题中对应的特色图片,从而达到让所有文章的特色图各有特色。
date 的值尽量保证每篇文章是唯一的,因为某些主题中 Gitalk 和 Gitment 识别 id 是通过 date 的值来作为唯一标识的。

赞(2)
未经允许不得转载:工具盒子 » Hexo Front-Matter介绍