/DocumentCenter

E发票文档中心

Primary LanguageCSS

DocumentCenter

E发票文档中心

使用说明

目前所有的文档都存放在documents目录下,采用文件夹+README.md文件来表示一篇文档,结构如下:

文件夹

README.md
manifest

文件夹可以嵌套,文件夹的层级关系即表示文档菜单的层级关系, 目前最多支持3菜单结构。
文档中心的首页文档内容存在documents/README.md中。

结构说明

文件夹

文件夹的名称就是该篇文档的名称。
文件夹的名称中如果包含下划线‘_',那么系统将以下划线为分割点,下划线前面部分是在菜单在同一层级的顺序,下划线后面才是该菜单的名称,举例说明:


文件结构

1.1 xxx

README.md

1.2 xxx

README.md

将生成菜单

1.1 xxx
1.2 xxx


文件结构

001_1.2 xxx

README.md

002_1.1 xxx

README.md

将生成菜单

1.2 xxx
1.1 xxx

因为此时的排序是按照下划线前面的内容001和002排序,所以1.2 xxx在1.1 xxx前面。

README.md

该文件用来存其所属文件夹所对应文档的内容,需使用markdown语法来编写文档。
如果文档中需要使用图片,需将图片和文档放在同一目录下且需要注意documents目录下所有图片名称不能重复

manifest

该文件不必需存在。如果存在,文件内容需要遵循以下格式:

name=xxx

该name覆盖该文件所在文件夹所对应的菜单的名称,举例说明:


文件结构

1.1 xxx

README.md

将生成菜单

1.1 xxx


文件结构

1.1 xxx

README.md
manifest

manifest文件内容为:

name=我将覆盖菜单名称

将生成菜单

我将覆盖菜单名称