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

cleanup configuration docs

Browse Source
This commit is contained in:
Robert Kaussow 2021-01-24 12:04:40 +01:00
parent 1c5e86904c
commit 84f37fca9a
No known key found for this signature in database
GPG Key ID: 65362AE74AF98B61
1 changed files with 15 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -54,8 +54,7 @@ enableGitInfo = true
# You can also specify this parameter per page in front matter. # You can also specify this parameter per page in front matter.
geekdocBreadcrumb = false geekdocBreadcrumb = false
# (Optional, default none) Set source repository location # (Optional, default none) Set source repository location. Used for 'Edit this page' links.
# Used for 'Edit this page' links
# You can also specify this parameter per page in front matter. # You can also specify this parameter per page in front matter.
geekdocRepo = "https://github.com/thegeeklab/hugo" geekdocRepo = "https://github.com/thegeeklab/hugo"
@ -134,8 +133,7 @@ params:
# You can also specify this parameter per page in front matter. # You can also specify this parameter per page in front matter.
geekdocBreadcrumb: false geekdocBreadcrumb: false
# (Optional, default none) Set source repository location # (Optional, default none) Set source repository location. Used for 'Edit this page' links.
# Used for 'Edit this page' links
# You can also specify this parameter per page in front matter. # You can also specify this parameter per page in front matter.
geekdocRepo: "https://github.com/thegeeklab/hugo-geekdoc" geekdocRepo: "https://github.com/thegeeklab/hugo-geekdoc"
@ -180,7 +178,7 @@ params:
# Set type to 'posts' if you want to render page as blogpost # Set type to 'posts' if you want to render page as blogpost
type = "posts" type = "posts"
# Set page weight to re-arrange items in file-tree menu # Set page weight to re-arrange items in file-tree menu.
weight = 10 weight = 10
# Set how many table of contents levels to be showed on page. # Set how many table of contents levels to be showed on page.
@ -192,7 +190,7 @@ geekdocDescription =
# Show a breadcrumb navigation bar at the top of each docs page. # Show a breadcrumb navigation bar at the top of each docs page.
geekdocBreadcrumb = false geekdocBreadcrumb = false
# Set source repository location # Set source repository location.
geekdocRepo = "https://github.com/thegeeklab/hugo-geekdoc" geekdocRepo = "https://github.com/thegeeklab/hugo-geekdoc"
# Enable "Edit this page" links. Requires 'GeekdocRepo' param and path must point # Enable "Edit this page" links. Requires 'GeekdocRepo' param and path must point
@ -203,20 +201,20 @@ geekdocEditPath = "edit/master/exampleSite/content"
# Can be overwritten by a path relative to 'geekdocEditPath' # Can be overwritten by a path relative to 'geekdocEditPath'
geekdocFilePath = geekdocFilePath =
# Set to mark page as flat section (file-tree menu only) # Set to mark page as flat section (file-tree menu only).
geekdocFlatSection = true geekdocFlatSection = true
# Set true to hide page or section from side menu (file-tree menu only) # Set true to hide page or section from side menu (file-tree menu only).
geekdocHidden = true geekdocHidden = true
# Set false to show this page as a file-tree menu entry when you want it to be hidden in the sidebar. # Set false to show this page as a file-tree menu entry when you want it to be hidden in the sidebar.
# NOTE: Only applies when 'geekdocHidden = true'. # NOTE: Only applies when 'geekdocHidden = true'.
geekdocHiddenTocTree = true geekdocHiddenTocTree = true
# Set to true to make a section foldable in side menu (file-tree menu only) # Set to true to make a section foldable in side menu.
geekdocCollapseSection = true geekdocCollapseSection = true
# Add an anchor link to headlines # Add an anchor link to headlines.
geekdocAnchor = true geekdocAnchor = true
``` ```
@ -224,10 +222,10 @@ geekdocAnchor = true
{{< tab "YAML" >}} {{< tab "YAML" >}}
```Yaml ```Yaml
# Set type to 'posts' if you want to render page as blogpost # Set type to 'posts' if you want to render page as blogpost.
type: "posts" type: "posts"
# Set page weight to re-arrange items in file-tree menu # Set page weight to re-arrange items in file-tree menu.
weight: 10 weight: 10
# Set how many table of contents levels to be showed on page. # Set how many table of contents levels to be showed on page.
@ -239,7 +237,7 @@ geekdocDescription:
# Show a breadcrumb navigation bar at the top of each docs page. # Show a breadcrumb navigation bar at the top of each docs page.
geekdocBreadcrumb: false geekdocBreadcrumb: false
# Set source repository location # Set source repository location.
geekdocRepo: "https://github.com/thegeeklab/hugo-geekdoc" geekdocRepo: "https://github.com/thegeeklab/hugo-geekdoc"
# Enable "Edit this page" links. Requires 'GeekdocRepo' param and path must point # Enable "Edit this page" links. Requires 'GeekdocRepo' param and path must point
@ -250,20 +248,20 @@ geekdocEditPath: "edit/master/exampleSite/content"
# Can be overwritten by a path relative to 'geekdocEditPath' # Can be overwritten by a path relative to 'geekdocEditPath'
geekdocFilePath: geekdocFilePath:
# Set to mark page as flat section (file-tree menu only) # Set to mark page as flat section (file-tree menu only).
geekdocFlatSection: true geekdocFlatSection: true
# Set true to hide page or section from side menu (file-tree menu only) # Set true to hide page or section from side menu (file-tree menu only).
geekdocHidden: true geekdocHidden: true
# Set false to show this page as a file-tree menu entry when you want it to be hidden in the sidebar. # Set false to show this page as a file-tree menu entry when you want it to be hidden in the sidebar.
# NOTE: Only applies when 'geekdocHidden: true'. # NOTE: Only applies when 'geekdocHidden: true'.
geekdocHiddenTocTree: true geekdocHiddenTocTree: true
# Set to true to make a section foldable in side menu (file-tree menu only) # Set to true to make a section foldable in side menu.
geekdocCollapseSection: true geekdocCollapseSection: true
# Add an anchor link to headlines # Add an anchor link to headlines.
geekdocAnchor: true geekdocAnchor: true
``` ```