博客概览

博客模块为博客站点提供了基本的布局和模板。

Modulegithub.com/hbstack/blog
Repository⭐ Please consider giving a star if your like it.
Stars
Version
Used by
Requirements
License
UsageSee how to use modules.

站点参数

ParameterTypeDefaultDescription
blog.full_widthbooleanfalse是否全宽。
blog.paginatenumber9每页博文数量。
blog.post_date_formatstring:date_long博文日期格式。
blog.post_thumbnailbooleantrue是否显示缩略图。
blog.post_thumbnail_defaultstringimages/thumbnail.png相对于 assets 文件夹的默认缩略图。
blog.post_thumbnail_placeholderstring站点标题缩略图占位符。
blog.archivesobject归档设置。
blog.archives.paginatenumber30归档每页博文数量。
blog.homeobject博客首页设置。
blog.home.featured_postsnumber10特刊博文数量。
blog.home.main_sectionsarray-博文栏目,默认所有栏目。
blog.home.taxonomiesbooleantrue是否于首页显示分类统计。
terms.paginatenumber12分类列表博文数量。

params.toml

 1[hb]
 2  [hb.blog]
 3    full_width = false
 4    paginate = 12
 5    post_date_format = ':date_long'
 6    post_thumbnail = true
 7    post_thumbnail_default = 'images/thumbnail.png'
 8    post_thumbnail_placeholder = ''
 9    [hb.blog.archives]
10      paginate = 30
11    [hb.blog.home]
12      featured_posts = 5
13      main_sections = ['docs', 'blog']
14      taxonomies = true
15  [hb.terms]
16    paginate = 12

params.yaml

 1hb:
 2  blog:
 3    archives:
 4      paginate: 30
 5    full_width: false
 6    home:
 7      featured_posts: 5
 8      main_sections:
 9      - docs
10      - blog
11      taxonomies: true
12    paginate: 12
13    post_date_format: :date_long
14    post_thumbnail: true
15    post_thumbnail_default: images/thumbnail.png
16    post_thumbnail_placeholder: ""
17  terms:
18    paginate: 12

params.json

 1{
 2   "hb": {
 3      "blog": {
 4         "archives": {
 5            "paginate": 30
 6         },
 7         "full_width": false,
 8         "home": {
 9            "featured_posts": 5,
10            "main_sections": [
11               "docs",
12               "blog"
13            ],
14            "taxonomies": true
15         },
16         "paginate": 12,
17         "post_date_format": ":date_long",
18         "post_thumbnail": true,
19         "post_thumbnail_default": "images/thumbnail.png",
20         "post_thumbnail_placeholder": ""
21      },
22      "terms": {
23         "paginate": 12
24      }
25   }
26}

页面参数

NameTypeDefaultDescription
commentsbooleantrue是否显示评论。
featuredbooleanfalse是否于首页幻灯片中显示该文章。
pinnedbooleanfalse是否于首页置顶该文章。

归档

博客博客内置了文章归档布局,其可以按年份和月份进行归档。你需要手动创建栏目以归档文章。

创建归档栏目

content/archives/_index.md
1---
2title: Archives
3---

创建按年归档栏目

archives/2023/ 为例。

content/archives/2023/_index.md
1---
2title: 2023
3---

创建按月归档栏目

archives/2023/01/ 为例。