From 2ac2a9faababa34508be349619741e4b3eae19cf Mon Sep 17 00:00:00 2001 From: Andreas Deininger Date: Wed, 5 Jan 2022 09:44:06 +0100 Subject: [PATCH] docs: fixed typos and minor textual improvements (#259) --- README.md | 2 +- exampleSite/content/_index.md | 2 +- exampleSite/content/shortcodes/columns.md | 4 ++-- exampleSite/content/usage/configuration.md | 6 +++--- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 6c92020..2080479 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ [![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) -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) diff --git a/exampleSite/content/_index.md b/exampleSite/content/_index.md index 0c81d24..37c88dd 100644 --- a/exampleSite/content/_index.md +++ b/exampleSite/content/_index.md @@ -1,6 +1,6 @@ --- 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 geekdocAlign: center geekdocAnchor: false diff --git a/exampleSite/content/shortcodes/columns.md b/exampleSite/content/shortcodes/columns.md index 46a5b22..5f37e00 100644 --- a/exampleSite/content/shortcodes/columns.md +++ b/exampleSite/content/shortcodes/columns.md @@ -9,12 +9,12 @@ The Columns shortcode can be used to organize content side-by-side (horizontally # Left Content Dolor sit, sumo unique argument um no ... -<---> +<---> # Mid Content Dolor sit, sumo unique argument um no ... -<---> +<---> # Right Content Dolor sit, sumo unique argument um no ... diff --git a/exampleSite/content/usage/configuration.md b/exampleSite/content/usage/configuration.md index d74778a..a381336 100644 --- a/exampleSite/content/usage/configuration.md +++ b/exampleSite/content/usage/configuration.md @@ -45,7 +45,7 @@ enableRobotsTXT = true # relative to your 'static/' folder. 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. geekdocMenuBundle = true @@ -71,7 +71,7 @@ enableRobotsTXT = true geekdocEditPath = "edit/main/exampleSite/content" # (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 # (Optional, default false) Display search results with the parent folder as prefix. This @@ -158,7 +158,7 @@ params: # relative to your 'static/' folder. 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. geekdocMenuBundle: true