The documentation is a work in progress, and English edition is just an empty shell for now. I will translate it when Chinese edition has done.
siteName | 站点名称。它会作为顶栏左侧图标旁指向主页的链接文本,也会被加到页面 <title> 后。如果此项为空,messages.home 会顶替上来,不过它不会被加进 <title> 。 |
dateFormat | 日期格式化字符串。v-no 使用 Day.js 格式化日期,你可以参考支持的格式化占位符列表填写。如果此项为空,会使用 Date 对象的 toDateString() 方法进行格式化(ddd MMM DD YYYY )。 |
smartQuotes | 用于将非开闭引号("' )转换为开闭引号的字符串或字符串数组。它会直接传入 markdown-it 的 quotes 字段用于初始化。你需要为它提供四个字符或字符串,分别指示双开闭引号和单开闭引号(比如 “”‘’ )。如果此项为空,或者长度小于四,都不会启用引号转换。 |
replacer | 用于在渲染过程中对一般文本进行替换的二维字符串数组。v-no 会遍历外层数组,用内部数组的第一个值构建全局正则表达式,并用第二个值替换它匹配到的字符串。因为结果是递进的,你可能需要注意一下它们的排列顺序。如果此项为空,它会被忽略。 |
cdn | 网站使用的 CDN 地址,需要以 / 结尾。它会被加到除 v-no 自身代码文件和配置文件以外的所有以 / 开头的站内链接的前面。你可以在这里找到更多有关 CDN 的内容。如果此项为空,它会被忽略。 |
cacheKey | 用于主动控制浏览器缓存的字符串或对象。如果这是一个字符串,它会被加到所有 .md 文件请求和自定义脚本 / 自定义样式链接的后面;如果它是一个对象,会被加到链接后的就是以文件路径为键对它索引到的值。如果你启用了 CDN,它并不能保证 CDN 会刷新它的缓存。你可以在这里找到更多有关浏览器缓存的内容。如果此项为空,它会被忽略。 |
paths 段
这里列出的配置项需要填入以 assets/
所在目录为根目录的绝对路径。
请保证它们以 /
开头、favicon
以外的文件路径以 .md
结尾,以及路径指向的文件都是存在的。只有 favicon
和 common
可以为空。
favicon | favicon 路径。除了浏览器标签页,它也会展示在顶栏的最左边。选用图片的分辨率最好大于 24 x 24 像素。如果此项为空,它会被忽略。 |
index | 主页文件路径。它是在 URL 无 Hash 部分时默认展示的文件,请把它当作网站的起点。需要注意,如果此项为 /index.md ,localhost/ 和 localhost/#/ 都会指向它,但后者只是因为 index.md 被省略了。 |
readme | 读我文件路径。因为 README.md 是 GitHub 之类的托管网站默认展示的文件,一般把它作为仓库的起点。你当然也可以仅仅把它当作顶栏右侧第一个链接指向的文件。 |
archive | 归档文件路径。一般把它用作文件索引、集中存放对其它文件的引用。它是顶栏右侧第二个链接指向的文件,和 readme 一样,一般怎么用只是个约定,除了固定在顶栏,它们和普通文件没有更多区别。 |
category | 分类文件路径。它被用于渲染分类页,承载了按标签自动汇总所有能被检索到的 .md 文件的功能。它是顶栏右侧第三个链接指向的文件,除了默认包含一个无参数生成列表,也只是个普通文件。 |
search | 搜索文件路径。它被用于渲染搜索页,承载了在所有能被检索到的 .md 文件中进行搜索的功能。它是顶栏右侧第四个链接指向的文件,会被预处理。 |
common | 通用文件路径。它会被加进除自己以外的其它文件中一并渲染,默认会加到文件尾。如果你使用 --8<-- 将它分成两部分,它们就会分别加到文件头和文件尾。如果此项为空,它会被忽略。 |
messages 段
方便进行本地化(l10n)的一些配置项。
home | siteName 为空时的替代,不会被加进 <title> 。 |
raw | 页头指向原始文件的链接文本。 |
footnotes | 文章底部加在脚注列表上方的文本。 |
returnHome | 页脚指向主页的链接文本。 |
lastUpdated | 在页面有多个不同的日期时,页脚右侧日期旁的文本。 |
untagged | 分类页里没有标签的页面的分类名。 |
pageError | 页面出错时用于构建错误文件的文本。它和普通文件享有同样的待遇,这意味着你可以使用嵌入链接导入一个专门的错误页放在这里。 |
searching | 搜索页正在搜索时的文本。 |
searchNothing | 搜索页的搜索结果为空时的文本。 |
showBacklinks | 页脚上方查看反链的链接文本。 |
noBacklinks | 没有反链时的文本。 |
loading | 正在加载反链时的文本。 |
redirectFrom | 重定向链接前的文本。 |
- This page is open source, improve it