文档配置

2021-01-01

该项为可选置项，array类型，包含名称，侧边栏等信息

在项目目录 config.toml，可配置该项

配置

 1[[document]]
 2name = "doc"
 3sidebar = [
 4    { number = "1.", name = "起步", node = [
 5        { name = "概览", route = "/doc/overview/" },
 6        { name = "入门", node = [
 7            { name = "本机运行", route = "/doc/start/local/" },
 8            { name = "docker运行", route = "/doc/start/docker/" },
 9        ] },
10    ] },
11    { number = "2.", name = "配置文件", node = [
12        { name = "新建站点", route = "/doc/create/site/" },
13        { name = "站点设置", route = "/doc/config/site/", node = [
14            { name = "代码高亮", route = "/doc/config/site/markdown/" },
15            { name = "加载图片", route = "/doc/config/site/image/" },
16            { name = "嵌入视频", route = "/doc/configsite/video/" },
17            { name = "信息流", route = "/doc/config/site/feeds/" },
18            { name = "网站地图", route = "/doc/config/site/sitemap/" },
19            { name = "robots.txt", route = "/doc/config/site/robots/" },
20        ] },
21        { name = "内容设置", node = [
22            { name = "文章", route = "/doc/config/article/" },
23            { name = "文档", route = "/doc/config/document/" },
24            { name = "单页", route = "/doc/config/page/" },
25            { name = "自定义页面", route = "/doc/config/customize/" },
26            { name = "国际化支持", route = "/doc/config/i18n/" },
27            { name = "静态文件", route = "/doc/config/static/" },
28        ] },
29    ] }
30]
31
32[[document]]
33……

Notice:

  • 该项为列表类型，支持配置多个非重名[name]配置项

释义

  1. name

    设置文档存储目录和渲染模板名称，string类型

  • 该目录需自行创建

  • 该目录支持多级子目录

  1. sidebar

    设置文档侧边栏，map[string]interface{}类型

  • node 支持多级嵌套

    • number: 文档编号

    • name: 文档名字

    • route: 文档地址，需与文件真实路径一致

    • node: 包含节点，可嵌套多个层级

举例

  1. 本地文件

    content/doc/why.md

content/doc/start/install.md

content/doc/start/cmd/site.md

  2. 侧边栏

  • 1 级

      sidebar = [
      { number = "1", name = "why", route = "/doc/why/" },
  ]

  • 2 级

      sidebar = [
      { number = "1", name = "why", route = "/doc/why/" },
      { number = "2", name = "start", node = [
          { name = "install", route = "/doc/start/install/" },
      ] },
  ]

  • 3 级

      sidebar = [
      { number = "1", name = "why", route = "/doc/why/" },
      { number = "2", name = "start", node = [
          { name = "install", route = "/doc/start/install/" },
          { name = "cmd", node = [
              { name = "site", route = "/doc/start/cmd/site/" },
          ] },
      ] },
  ]