31.md

目录索引文件

文档项目的目录索引文件 index.json 定义了文档的目录结构，文档文件的路径，文档的相关信息 ... DocMan 读取文档项目的目录索引文件 index.json ，根据它来组织文档结构。

必须有一个 index.json 位于文档项目的根目录中。

例如：

{
	"title": "DocMan 文档",
	"describe": "DocMan 官方文档",
	"author": "Monkeyhbd",
	"list": [
		{
			"title": "DocMan 简介",
			"path": "./01.md"
		},
		{
			"title": "DocMan 安装",
			"path": "./02.md"
		},
		{
			"title": "DocMan 文档目录",
			"describe": "文档目录 index.json ，项目信息和文档信息",
			"path": "./03.md"
		}
	]
}

最外层的信息是项目信息，标记文档项目的名称、描述、作者和目录；list 中的每一个对象是文章信息，标记了文章对象的名称、描述、路径和子目录。

项目信息

基本配置

名称	值
title	文档的标题
list	目录列表

扩展配置

名称	值
author	文档的作者
describe	对文档的描述

目录列表

目录列表 list 包含了一系列文章对象

文章信息

基本配置

名称	值
title	文章的标题。其值将显示在目录和标签页的标题上

扩展配置

名称	值
describe	文章的描述
path	输入的 Markdown 文件相对于文档项目目录的相对路径。若不定义此项，则不生成对应的 HTML 文件
outputPath 当前版本不支持	输出的 HTML 文件相对于发行目录的相对路径，默认为 ./
rename	重命名生成的 HTML 文件。默认与 Markdown 文档文件同名
list	目录列表。若定义此项，则生成一层子目录