docs: fixed typos and minor textual improvements (#259)
This commit is contained in:
parent
da8d7a48d6
commit
2ac2a9faab
4 changed files with 7 additions and 7 deletions
|
@ -6,7 +6,7 @@
|
||||||
[![GitHub contributors](https://img.shields.io/github/contributors/thegeeklab/hugo-geekdoc)](https://github.com/thegeeklab/hugo-geekdoc/graphs/contributors)
|
[![GitHub contributors](https://img.shields.io/github/contributors/thegeeklab/hugo-geekdoc)](https://github.com/thegeeklab/hugo-geekdoc/graphs/contributors)
|
||||||
[![License: MIT](https://img.shields.io/github/license/thegeeklab/hugo-geekdoc)](https://github.com/thegeeklab/hugo-geekdoc/blob/main/LICENSE)
|
[![License: MIT](https://img.shields.io/github/license/thegeeklab/hugo-geekdoc)](https://github.com/thegeeklab/hugo-geekdoc/blob/main/LICENSE)
|
||||||
|
|
||||||
Geekdoc is a simple Hugo theme for documentations. It is intentionally designed as a fast and lean theme and may not fit the requirements of complex projects. If a more feature-complete theme is required there are a lot of got alternatives out there. You can find a demo and the full documentation at [https://geekdocs.de](https://geekdocs.de).
|
Geekdoc is a simple Hugo theme for documentations. It is intentionally designed as a fast and lean theme and may not fit the requirements of complex projects. If a more feature-complete theme is required there are a lot of good alternatives out there. You can find a demo and the full documentation at [https://geekdocs.de](https://geekdocs.de).
|
||||||
|
|
||||||
![Desktop and mobile preview](https://raw.githubusercontent.com/thegeeklab/hugo-geekdoc/main/images/readme.png)
|
![Desktop and mobile preview](https://raw.githubusercontent.com/thegeeklab/hugo-geekdoc/main/images/readme.png)
|
||||||
|
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
---
|
---
|
||||||
title: Welcome to the documentation
|
title: Welcome to the documentation
|
||||||
description: Geekdoc is a simple Hugo theme for documentations. It is intentionally designed as a fast and lean theme and may not fit the requirements of complex projects. If a more feature-complete theme is required there are a lot of got alternatives out there.
|
description: Geekdoc is a simple Hugo theme for documentations. It is intentionally designed as a fast and lean theme and may not fit the requirements of complex projects. If a more feature-complete theme is required there are a lot of good alternatives out there.
|
||||||
geekdocNav: false
|
geekdocNav: false
|
||||||
geekdocAlign: center
|
geekdocAlign: center
|
||||||
geekdocAnchor: false
|
geekdocAnchor: false
|
||||||
|
|
|
@ -9,12 +9,12 @@ The Columns shortcode can be used to organize content side-by-side (horizontally
|
||||||
# Left Content
|
# Left Content
|
||||||
Dolor sit, sumo unique argument um no ...
|
Dolor sit, sumo unique argument um no ...
|
||||||
|
|
||||||
<---> <!-- magic sparator, between columns -->
|
<---> <!-- magic separator, between columns -->
|
||||||
|
|
||||||
# Mid Content
|
# Mid Content
|
||||||
Dolor sit, sumo unique argument um no ...
|
Dolor sit, sumo unique argument um no ...
|
||||||
|
|
||||||
<---> <!-- magic sparator, between columns -->
|
<---> <!-- magic separator, between columns -->
|
||||||
|
|
||||||
# Right Content
|
# Right Content
|
||||||
Dolor sit, sumo unique argument um no ...
|
Dolor sit, sumo unique argument um no ...
|
||||||
|
|
|
@ -45,7 +45,7 @@ enableRobotsTXT = true
|
||||||
# relative to your 'static/' folder.
|
# relative to your 'static/' folder.
|
||||||
geekdocLogo = "logo.png"
|
geekdocLogo = "logo.png"
|
||||||
|
|
||||||
# (Optional, default false) Render menu from data file im 'data/menu/main.yaml'.
|
# (Optional, default false) Render menu from data file in 'data/menu/main.yaml'.
|
||||||
# See also https://geekdocs.de/usage/menus/#bundle-menu.
|
# See also https://geekdocs.de/usage/menus/#bundle-menu.
|
||||||
geekdocMenuBundle = true
|
geekdocMenuBundle = true
|
||||||
|
|
||||||
|
@ -71,7 +71,7 @@ enableRobotsTXT = true
|
||||||
geekdocEditPath = "edit/main/exampleSite/content"
|
geekdocEditPath = "edit/main/exampleSite/content"
|
||||||
|
|
||||||
# (Optional, default true) Enables search function with flexsearch.
|
# (Optional, default true) Enables search function with flexsearch.
|
||||||
# Index is built on the fly and might slowdown your website.
|
# Index is built on the fly and might slow down your website.
|
||||||
geekdocSearch = false
|
geekdocSearch = false
|
||||||
|
|
||||||
# (Optional, default false) Display search results with the parent folder as prefix. This
|
# (Optional, default false) Display search results with the parent folder as prefix. This
|
||||||
|
@ -158,7 +158,7 @@ params:
|
||||||
# relative to your 'static/' folder.
|
# relative to your 'static/' folder.
|
||||||
geekdocLogo: logo.png
|
geekdocLogo: logo.png
|
||||||
|
|
||||||
# (Optional, default false) Render menu from data file im 'data/menu/main.yaml'.
|
# (Optional, default false) Render menu from data file in 'data/menu/main.yaml'.
|
||||||
# See also https://geekdocs.de/usage/menus/#bundle-menu.
|
# See also https://geekdocs.de/usage/menus/#bundle-menu.
|
||||||
geekdocMenuBundle: true
|
geekdocMenuBundle: true
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue