Document the hb.blog.home.pinned_posts_position parameter

hbstack · Dec 4, 2023 · ac819d0 · ac819d0
1 parent 58b35dd
commit ac819d0
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 0 deletions.
diff --git a/content/modules/blog/overview/index.en.md b/content/modules/blog/overview/index.en.md
@@ -39,6 +39,7 @@ The blog module provides the basic layouts and templates for blog site.
 | `blog.home`                       | object  |                        | Homepage settings.                                       |
 | `blog.home.featured_posts`        | number  |          `10`          | The number of featured posts.                            |
 | `blog.home.main_sections`         |  array  |           -            | The main sections of posts, default to ALL.              |
+| `blog.home.pinned_posts_position` | string  |    Next to carousel    | The position of pinned posts, available options: `list`. |
 | `blog.home.taxonomies`            | boolean |         `true`         | Whether to show the taxonomies stat on home page.        |
 | `terms.paginate` | number | `12` | The number of posts per term list page. |
 

diff --git a/content/modules/blog/overview/index.zh-hans.md b/content/modules/blog/overview/index.zh-hans.md
@@ -39,6 +39,7 @@ aliases:
 | `blog.home`                       | object  |                        | 博客首页设置。                       |
 | `blog.home.featured_posts`        | number  |          `10`          | 特刊博文数量。                       |
 | `blog.home.main_sections`         |  array  |           -            | 博文栏目，默认所有栏目。             |
+| `blog.home.pinned_posts_position` | string  |        幻灯片右侧        | 置顶文章的位置，可选项：`list`。     |
 | `blog.home.taxonomies`            | boolean |         `true`         | 是否于首页显示分类统计。             |
 | `terms.paginate` | number | `12` | 分类列表博文数量。 |
 

diff --git a/content/modules/blog/overview/index.zh-hant.md b/content/modules/blog/overview/index.zh-hant.md
@@ -39,6 +39,7 @@ aliases:
 | `blog.home`                       | object  |                        | 博客首頁設置。                       |
 | `blog.home.featured_posts`        | number  |          `10`          | 特刊博文數量。                       |
 | `blog.home.main_sections`         |  array  |           -            | 博文欄目，默認所有欄目。             |
+| `blog.home.pinned_posts_position` | string  |        幻燈片右側        | 置頂文章的位置，可選項：`list`。     |
 | `blog.home.taxonomies`            | boolean |         `true`         | 是否於首頁顯示分類統計。             |
 | `terms.paginate` | number | `12` | 分類列表博文數量。 |