文档格式页面
说明
这里的academic模板版本是4.6.3，hugo版本是0.58.3 extended。在academic5.0之后的版本中将出现 book 类型，可能会取代 docs 类型
文档类型主要是用于展示手册或文档之类的内容，主要的特点是：
- 右侧有书签式的目录，可以分两级；
- 页内有页面的链接。
文件结构
文档格式的页面通常是设置在某个目录下，相关的文件在此目录下根据一定的格式配置。
目录页
目录页是这个目录，也就是文件夹下所有文档的一个大清单，如这个文档可以有2个章，1. Hugo教程；2. Emacs教程。
目录页——对应该文件夹根目录下 _index.md ，为了区分，以下称为：“目index”
章节页
章节页则是点击目录中的链接后到达的章节页面，每个章节单独建立一个文件夹，如： Hugo 和 Emacs , 这个文件夹名以下称为“章folder”
在这两个文件夹下也各自有一个 _index.md 文件，以下称为：“页index”，这个index对应的html页面也是目录页中点击后到达的页面，以下称为“默认页”。
内容页
在到达页index后，在左侧有一个目录（以下称为“左目录”），这个目录的每一个页面是内容页（以下称为“右内容”），对应“页md”文件。
目录页
显示及对应关系
| No. | 页面元素 | 对应文件元素 |
|---|---|---|
| 1 | 页面大标题 | 目index——title |
| 2 | 页面可以设置banner | 目index——header |
| 3 | 章节标题 | 页index——linktitle |
| 4 | 章节标题下的摘要 | 页index——summary |
| 5 | 章节排序 | 页index——weight |
目_index.md举例
---
title: 页面大标题
layout: docs # Do not modify.
# Optional header image (relative to `static/img/` folder).
header:
caption: ""
image: ""
---
文档页
说明一下默认页，在点击目录页的章节标题后，会跳转到文档页的一个默认页面，这个默认页面内容主要来自于页index，也就是 _index.md 这个文件。
文档页的左目录可以定为2级。
| No. | 页面元素 | 对应文件元素 |
|---|---|---|
| 1 | 默认页左目录 | 页index——menu:章folder:name: |
| 2 | 默认页左目录排序 | 页index——menu:章folder:weight: |
| 3 | 文档页右内容标题 | 页md——title: |
| 4 | 文档页左目录标题 | 页md——linktitle: |
| 5 | 文档页左目录标题排序 | 页md——menu:章folder:weight: |
| 6 | 文档页左目录二级标题 | 页md——menu:章folder:parent:二级标题名 |
页_index.md举例
---
linktitle: 章节标题
summary: 章节标题下的摘要
# 页index——weight，也就是章节标题在目录页的显示顺序
weight: 1
# Page metadata.
title: 文档页右内容的标题
date: "2018-09-09T00:00:00Z"
lastmod: "2018-09-09T00:00:00Z"
draft: false # 是否是草稿
toc: true # 是否显示页内目录
type: docs # 不要动
menu: # 如果这个元素整个删除，则这个默认页在文档页的左侧不显示目录
example: # 这要和章节所设置的目录名相同
name: 默认页在左侧目录显示的标题 # 如果内容是空："" ，左侧也不显示目录
weight: 1 # 在左侧目录中的显示排序
---
内容页
内容页位于章节文件夹下，与页index处于同一目录，页md。
内容页举例
---
title: 内容右侧标题
linktitle: 文档页左侧目录标题
toc: true # 内容页是否显示页内目录
type: docs # 不要动
date: "2019-05-05T00:00:00+01:00"
draft: false
menu:
example: # 这要和章节所设置的目录名相同
parent: 一级目录名 # 说明这个页面处于“一级目录名”下，二级目录名就是上面的 =linktitle= ，如果一级目录名下有多个二级，那么这几个二级要用同样的一级目录名。这个parent无需定义上级文档即可直接使用，如果没有事先定义，则点击就跳转到它下一级的第一个文档。
weight: 1
# Prev/next pager order (if `docs_section_pager` enabled in `params.toml`)
weight: 1
---