add documentation for different menu type

uci-hugo-doc
Robert Kaussow 2020-12-20 22:45:21 +01:00
parent 7870171604
commit 2f90aa4d95
No known key found for this signature in database
GPG Key ID: 65362AE74AF98B61
4 changed files with 31 additions and 5 deletions

View File

@ -1,9 +1,12 @@
.envrc
.tarignore
.dictionary*
.git*
.drone*
.lighthouse*
.markdownlint*
.jsbeautify*
.prettier*
example*
gulp*
package*

View File

@ -22,7 +22,7 @@ If you want to use the theme from a cloned branch instead of a release tarball y
npm install
# run gulp pipeline to build required assets
gulp default
npx gulp default
```
## Using the theme
@ -98,5 +98,5 @@ git clone https://github.com/thegeeklab/hugo-geekdoc.git themes/geekdoc
Build required theme assets e.g. CSS files and SVG sprites with `gulp`.
```Shell
gulp default
npx gulp default
```

View File

@ -1,7 +1,30 @@
---
draft: true
---
The theme supports two different kinds of menus. [File-tree menu](#file-tree-menu) is the default one and does not require further configuration to work. If you want full control about your menu the [bundle menu](#bundle-menu) is a powerful option to accomplish it.
## File-tree menu
As the name already suggests, the file tree menu builds a menu from the file system structure of the content folder. By default, areas and subareas are sorted alphabetically by the title of the pages. To manipulate the order the `weight` parameter in a page [front matter](https://gohugo.io/content-management/front-matter/) can be used. To structure your content folder you have to use [page bundles](https://gohugo.io/content-management/organization/#page-bundles), single files are **not** supported. Hugo will render build single files in the content folder just fine but it will not be added to the menu.
**Example:**
A file structure like shown below...
```plain
content/
├── level-1
│   ├── _index.md
│   ├── level-1-1.md
│   ├── level-1-2.md
│   └── level-1-3
│   ├── _index.md
│   └── level-1-3-1.md
└── level-2
├── _index.md
├── level-2-1.md
└── level-2-2.md
```
... results in a menu that looks like this.
[![Example file-tree menu](/media/file-tree.png)](/media/file-tree.png)
## Bundle menu

Binary file not shown.

After

Width:  |  Height:  |  Size: 80 KiB