浏览模块

博客概览

2023年3月31日 2 分钟阅读 模块 文档 博客
本页内容
赞助

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

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.list_cols_mdnumber2于 md 断点下，列表每行的文章数目。
blog.list_cols_lgnumber3于 lg 断点下，列表每行的文章数目。
blog.paginatenumber9每页博文数量。
blog.post_date_formatstring:date_long博文日期格式。
blog.post_thumbnailbooleantrue是否显示缩略图。
blog.post_thumbnail_defaultstringimages/thumbnail.png相对于 assets 文件夹的默认缩略图。
blog.post_thumbnail_placeholderstring站点标题缩略图占位符。
blog.post_thumbnail_positionstringtop缩略图的位置，start 或 top。
blog.archivesobject归档设置。
blog.archives.paginatenumber30归档每页博文数量。
blog.homeobject博客首页设置。
blog.home.featured_postsnumber10特刊博文数量。
blog.home.main_sectionsarray-博文栏目，默认所有栏目。
blog.home.pinned_posts_positionstring幻灯片右侧置顶文章的位置，可选项：list。
blog.home.taxonomiesbooleantrue是否于首页显示分类统计。
blog.toc.positionstringendstart：内容左侧、end：内容右侧、content：内容上方。
terms.paginatenumber12分类列表博文数量。

params.toml

 1[hb]
 2  [hb.blog]
 3    full_width = false
 4    list_cols_lg = 3
 5    list_cols_md = 2
 6    paginate = 12
 7    post_date_format = ':date_long'
 8    post_thumbnail = true
 9    post_thumbnail_default = 'images/thumbnail.png'
10    post_thumbnail_placeholder = ''
11    post_thumbnail_position = 'top'
12    [hb.blog.archives]
13      paginate = 30
14    [hb.blog.home]
15      featured_posts = 5
16      main_sections = ['docs', 'blog']
17      taxonomies = true
18    [hb.blog.toc]
19      position = 'end'
20  [hb.terms]
21    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    list_cols_lg: 3
13    list_cols_md: 2
14    paginate: 12
15    post_date_format: :date_long
16    post_thumbnail: true
17    post_thumbnail_default: images/thumbnail.png
18    post_thumbnail_placeholder: ""
19    post_thumbnail_position: top
20    toc:
21      position: end
22  terms:
23    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         "list_cols_lg": 3,
17         "list_cols_md": 2,
18         "paginate": 12,
19         "post_date_format": ":date_long",
20         "post_thumbnail": true,
21         "post_thumbnail_default": "images/thumbnail.png",
22         "post_thumbnail_placeholder": "",
23         "post_thumbnail_position": "top",
24         "toc": {
25            "position": "end"
26         }
27      },
28      "terms": {
29         "paginate": 12
30      }
31   }
32}

页面参数

NameTypeDefaultDescription
commentsbooleantrue是否显示评论。
external_urlstring-外部文章 URL。
featuredbooleanfalse是否于首页幻灯片中显示该文章。
pinnedbooleanfalse是否于首页置顶该文章。
tocbooleantrue是否显示文章目录。
metaboolean/objecttrue为 false 时，禁用所有元信息。
meta.authorsbooleantrue为 false 时，禁用作者元信息。
meta.datebooleantrue为 false 时，禁用日期元信息。
meta.reading_timebooleantrue为 false 时，禁用阅读时长元信息。
meta.taxonomiesbooleantrue为 false 时，禁用专栏、分类和标签元信息。

归档

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

创建归档栏目

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

创建按年归档栏目

以 archives/2023/ 为例。

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

创建按月归档栏目

以 archives/2023/01/ 为例。

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