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.
这里列出的配置项需要填入以 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<-- 将它分成两部分,它们就会分别加到文件头和文件尾。如果此项为空,它会被忽略。 |
- This page is open source, improve it