github/hugo-geekdoc
0
0
Fork 0
mirror of https://github.com/thegeeklab/hugo-geekdoc.git synced 2024-11-22 04:40:40 +00:00
Code Issues Projects Releases Wiki Activity

add toc to dictionary

Browse Source
This commit is contained in:
Robert Kaussow 2021-04-10 13:06:07 +02:00
parent fb8d22d967
commit 9129b07d2f
No known key found for this signature in database
GPG Key ID: 65362AE74AF98B61
7 changed files with 1 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.dictionary
View File

@ -4,6 +4,7 @@ Shpak
(S|s)hortcode[s]? (S|s)hortcode[s]?
hugo-book hugo-book
ToC ToC
toc
macOS macOS
SVG SVG
HC-primary HC-primary

4
exampleSite/content/shortcodes/toc.md
View File

@ -4,12 +4,8 @@ Simple wrapper to generate a page Table of Content from a shortcode.
{{</* toc */>}} {{</* toc */>}}
``` ```
<!-- spellchecker-disable -->
{{< toc >}} {{< toc >}}
<!-- spellchecker-enable -->
## Level 1 ## Level 1
Dolor sit, sumo unique argument um no. Gracie nominal id xiv. Romanesque acclimates investiture. Ornateness bland it ex enc, est yeti am bongo detract re. Pro ad prompts feud gait, quid exercise emeritus bis e. In pro quints consequent, denim fastidious copious quo ad. Stet probates in duo. Dolor sit, sumo unique argument um no. Gracie nominal id xiv. Romanesque acclimates investiture. Ornateness bland it ex enc, est yeti am bongo detract re. Pro ad prompts feud gait, quid exercise emeritus bis e. In pro quints consequent, denim fastidious copious quo ad. Stet probates in duo.

4
exampleSite/content/usage/code-blocks.md
View File

@ -1,11 +1,7 @@
There are multiple ways to add code blocks. Most of them works out of the box only the Hugo shortcode `<highlight>` need some configuration to work properly. There are multiple ways to add code blocks. Most of them works out of the box only the Hugo shortcode `<highlight>` need some configuration to work properly.
<!-- spellchecker-disable -->
{{< toc >}} {{< toc >}}
<!-- spellchecker-enable -->
## Inline code ## Inline code
To display an inline shortcode use single quotes: To display an inline shortcode use single quotes:

4
exampleSite/content/usage/configuration.md
View File

@ -3,12 +3,8 @@ title: Configuration
weight: -10 weight: -10
--- ---
<!-- spellchecker-disable -->
{{< toc >}} {{< toc >}}
<!-- spellchecker-enable -->
## Site configuration ## Site configuration
{{< tabs "site-config" >}} {{< tabs "site-config" >}}

4
exampleSite/content/usage/getting-started.md
View File

@ -5,12 +5,8 @@ weight: -20
This page tells you how to get started with the Geekdoc theme, including installation and basic configuration. This page tells you how to get started with the Geekdoc theme, including installation and basic configuration.
<!-- spellchecker-disable -->
{{< toc >}} {{< toc >}}
<!-- spellchecker-enable -->
## Install requirements ## Install requirements
You need a recent version of Hugo for local builds and previews of sites that use Geekdoc. As we are using [gulp](https://gulpjs.com/) as pre-processor the normal version of Hugo is sufficient. If you prefer the extended version of Hugo anyway this will work as well. For comprehensive Hugo documentation, see [gohugo.io](https://gohugo.io/documentation/). You need a recent version of Hugo for local builds and previews of sites that use Geekdoc. As we are using [gulp](https://gulpjs.com/) as pre-processor the normal version of Hugo is sufficient. If you prefer the extended version of Hugo anyway this will work as well. For comprehensive Hugo documentation, see [gohugo.io](https://gohugo.io/documentation/).

4
exampleSite/content/usage/icons.md
View File

@ -2,12 +2,8 @@
title: Icons title: Icons
--- ---
<!-- spellchecker-disable -->
{{< toc >}} {{< toc >}}
<!-- spellchecker-enable -->
## Custom icons ## Custom icons
The only supported source for custom icons are SVG sprites. Some icon frameworks provides ready to use sprites e.g. FontAwesome. If the framework don't provide sprites, you can create your own from raw SVG icons. There are a lot of tools available to create sprites, please choose one that fits your need. One solution could be [svgsprit.es](https://svgsprit.es/). The only supported source for custom icons are SVG sprites. Some icon frameworks provides ready to use sprites e.g. FontAwesome. If the framework don't provide sprites, you can create your own from raw SVG icons. There are a lot of tools available to create sprites, please choose one that fits your need. One solution could be [svgsprit.es](https://svgsprit.es/).

4
exampleSite/content/usage/menus.md
View File

@ -1,11 +1,7 @@
The theme supports two different kinds of menus. 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 is a powerful option to accomplish it. The theme supports two different kinds of menus. 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 is a powerful option to accomplish it.
<!-- spellchecker-disable -->
{{< toc >}} {{< toc >}}
<!-- spellchecker-enable -->
## File-tree menu ## 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. 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.