diff --git a/man/cookbook/apis/site-config/readme.md b/man/cookbook/apis/site-config/readme.md index 6f62fa2..616a1cd 100644 --- a/man/cookbook/apis/site-config/readme.md +++ b/man/cookbook/apis/site-config/readme.md @@ -1,9 +1,23 @@ 在网站配置文件中声明的用于控制主题预置渲染逻辑的配置项,整体是个多层嵌套的对象,在本文档中的表现形式为: -1. 一级属性会作为二级标题,然后紧接着是对其的简单说明; -2. 二级属性列在表格中,若需要更为详细的解释,则会另起三级标题; +1. 一级属性会作为三级标题,然后紧接着是对其的简单说明; +2. 二级属性列在表格中,若需要更为详细的解释,则会另起四级标题; 3. 三级及以下层级的属性会以 TypeScript 的类型定义的方式呈现。 +由于不同静态网站生成器所支持功能之间的差异性,为适配本身不支持或支持得不完善的功能的配置项,会在相应的网站配置文件中挂在 `ksio` 这个「命名空间」下: + +```yaml +ksio: + # 本页所列举的配置 +``` + +即便如此,并非所有配置项都要挂在 `ksio` 下,要视情况而定。另外,上面说的「一级属性」等是不包含 `ksio` 这一层的,即从 `ksio` 的下一层开始算起。 + +为方便查找,以下内容按字母顺序排列—— + +## 模板 +{:#template} + 当配置项「值类型」有 `Link` 字样的,代表 `Link` 是一个描述链接信息的对象: ```typescript @@ -14,9 +28,7 @@ interface Link { } ``` -为方便查找,以下内容按字母顺序排列—— - -## `brand` +### `brand` 品牌相关配置,主要控制页头左上角的链接与文本。 @@ -27,15 +39,15 @@ interface Link { | `parent` | `Link` | - | 当前网站的父品牌,指定后会在当前网站品牌的左边显示 | | `text` | `string` | 网站标题 | 当前网站品牌所要显示的文本,不指定则显示网站标题 | -### `color` +#### `color` 设置之后,会在 `
` 标签内生成 [``](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/meta/name/theme-color){:target="_blank"}{:rel="external nofollow"}。 -### `icon` +#### `icon` 除了会通过 `` 显示在网页浏览器标签中以外,还会用于 SEO 等其他信息中。 -## `copyright` +### `copyright` 网站版权声明。 @@ -46,13 +58,13 @@ interface Link { | `period` | `CopyrightPeriod` | - | 有效期间,[详见下方](#period) | | `provider` | `boolean` | `true` | 是否显示主题与提供者声明 | -### `fragments` +#### `fragments` 值是可以包含 HTML 的字符串,最好每段内容都包含在 `` 标签中,相邻的 `
` 标签之间会显示一个垂直的分隔符。 若 `provider` 没设为 `false`,整个内容会显示在主题与提供者声明右侧。 -### `period` +#### `period` ```typescript interface CopyrightPeriod { @@ -60,7 +72,7 @@ interface CopyrightPeriod { } ``` -## `footer` +### `footer` 页面底部。 @@ -69,7 +81,7 @@ interface CopyrightPeriod { | `links` | `Link[]` | - | 页面底部链接 | | `partial` | `string` | `'ksio/partials/footer.html'` | 预置布局模板中页脚部分,可指定自定义的替换主题预置的 | -## `header` +### `header` 页面头部。 @@ -79,7 +91,7 @@ interface CopyrightPeriod { | `navs` | `Link[]` | - | 页面头部导航 | | `partial` | `string` | `'ksio/partials/header.html'` | 预置布局模板中页头部分,可指定自定义的替换主题预置的 | -### `navbar` +#### `navbar` ```typescript interface HeaderNavBar { @@ -87,7 +99,7 @@ interface HeaderNavBar { } ``` -## `master` +### `master` 站长信息。 @@ -95,11 +107,11 @@ interface HeaderNavBar { | --- | --- | --- | --- | | `name` | `string` | - | 站长名称,[详见下方](#name) | -### `name` +#### `name` 在使用 Jekyll 时,一般会在网站配置文件中定义一个 `author`,因此在 Jekyll 中使用本主题时若没指定 `name` 则会使用 `site.author.name`。 -## `meta` +### `meta` 网站信息。 @@ -107,7 +119,7 @@ interface HeaderNavBar { | --- | --- | --- | --- | | `url` | `string` | - | 网站发布后的访问链接 | -## `seo` +### `seo` SEO 相关配置。 @@ -115,7 +127,7 @@ SEO 相关配置。 | --- | --- | --- | --- | | `suffix` | `boolean` | `true` | 是否在 `