Skip to content

Latest commit

 

History

History
39 lines (31 loc) · 1.2 KB

config.md

File metadata and controls

39 lines (31 loc) · 1.2 KB

自定义参数

规则

可以通过根目录下的 config.json 文件配置自定义参数,具体如下:

{
	"name": "项目名称,必填",
	"introduction": "Wiki 首页的项目介绍,必填",
	"title": "页面的 title 标签的内容,非必填",
	"keywords": "页面的 keywords 标签的内容,非必填",
	"description": "页面的 description 标签的内容,非必填",
	"path": {
		"content": "正文的文件夹路径,相对路径绝对路径皆可,默认根目录,非必填",
		"images": "引用图片的文件夹路径,相对路径绝对路径皆可,默认为根目录下的 images 文件夹,非必填",
		"readme": "关于页面的路径,相对路径绝对路径皆可,默认根目录下的 README.md,非必填",
		"toc": "目录的路径,相对路径绝对路径皆可,默认根目录下的 TOC.md,非必填"
		}
}

示例

GitHub 仓库地址:https://github.com/Unknwon/the-way-to-go_ZH_CN

Wiki 项目地址:http://wiki.jikexueyuan.com/project/the-way-to-go/

{
	"name": "Go 入门指南",
	"introduction": "Go 经典书籍《The Way To Go》的中文译本。",
	"path": {
		"content": "eBook",
		"readme": "README_gc.md"
	}

}