Skip to content

Commit

Permalink
docs(api): more front matter variables
Browse files Browse the repository at this point in the history
  • Loading branch information
ourai committed Apr 22, 2023
1 parent defa3a2 commit 3b710e4
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions man/cookbook/apis/page-config/readme.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,34 @@
页面配置即定义在 Front Matter 中的变量,除了会用到静态网站生成器预定义与约定俗成的变量之外,本主题也自定义了一些——

## 资源注入

除了整站共用的个别静态资源会写死在 `</head>``</body>` 前方之外,有些只跟特定布局和页面绑定的静态资源得按需注入,可与[设置页面配置默认值]({{ site.baseurl }}/zh/apis/site-config/#defaults)的能力相结合:

| 变量名 | 值类型/可选值 | 说明 |
| --- | --- | --- |
| `ksio_asset_js` | `string | string[]` | 省略扩展名的 JS 文件路径 |
| `ksio_asset_css` | `string | string[]` | 省略扩展名的 CSS 文件路径 |

## 布局插槽

主题预置布局模板中部分区域的内容可在外部自定义,这些区域叫做「插槽」:

| 变量名 | 值类型/可选值 | 说明 |
| ---| --- | --- |
| `ksio_slot_banner` | `string` | 头图 |
| `ksio_slot_header` | `string` | 头部 |
| `ksio_slot_title` | `string` | 标题 |
| `ksio_slot_meta` | `string` | 作者、标签等信息 |
| `ksio_slot_content` | `string` | 正文 |
| `ksio_slot_footer` | `string` | 底部,大尺寸设备中视觉上是正文右侧 |
| `ksio_slot_aside` | `string` | 侧边栏 |

## 功能开关

| 变量名 | 值类型/可选值 | 说明 |
| --- | --- | --- |
| `ksio_shareable` | `boolean` | 是否显示分享按钮 |

## SEO

影响生成 SEO 相关信息的变量:
Expand Down

0 comments on commit 3b710e4

Please sign in to comment.