diff --git a/.tarignore b/.tarignore index 2c79ca3..575d4a3 100644 --- a/.tarignore +++ b/.tarignore @@ -1,9 +1,12 @@ +.envrc .tarignore .dictionary* .git* .drone* .lighthouse* .markdownlint* +.jsbeautify* +.prettier* example* gulp* package* diff --git a/exampleSite/content/usage/getting-started.md b/exampleSite/content/usage/getting-started.md index deec6aa..3c7fa91 100644 --- a/exampleSite/content/usage/getting-started.md +++ b/exampleSite/content/usage/getting-started.md @@ -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 ``` diff --git a/exampleSite/content/usage/menus.md b/exampleSite/content/usage/menus.md index 201db96..5084554 100644 --- a/exampleSite/content/usage/menus.md +++ b/exampleSite/content/usage/menus.md @@ -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 diff --git a/exampleSite/static/media/file-tree.png b/exampleSite/static/media/file-tree.png new file mode 100644 index 0000000..ae170db Binary files /dev/null and b/exampleSite/static/media/file-tree.png differ