From 826a3b6937850974467e5b1aa8e4e327df54e492 Mon Sep 17 00:00:00 2001 From: laundry-96 Date: Fri, 27 Oct 2023 04:32:25 +0200 Subject: [PATCH] Added prerequisites for content creation. Added configuration options for the hugo module and added Prerequistes section to create the content directory. --- README.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1519fab..8595fe0 100644 --- a/README.md +++ b/README.md @@ -61,6 +61,9 @@ The Lotus Docs theme can be installed using one of the following methods: - As a Git submodule - Clone the theme files locally +Prerequisites: +- `contentDir` present in project folder + ### Install as a Hugo Module (recommended) Edit the `hugo.toml` configuration file to include the [Lotus Docs theme](https://github.com/colinwilson/lotusdocs) and the [Hugo Bootstrap module](https://github.com/gohugoio/hugo-mod-bootstrap-scss) as modules: @@ -69,6 +72,8 @@ Edit the `hugo.toml` configuration file to include the [Lotus Docs theme](https: baseURL = 'http://example.org/' languageCode = 'en-us' title = 'My New Hugo Site' +contentDir = 'content' +enableEmoji = true [module] [[module.imports]] @@ -77,6 +82,17 @@ title = 'My New Hugo Site' [[module.imports]] path = "github.com/gohugoio/hugo-mod-bootstrap-scss/v5" disable = false + +[markup] + [markup.tableOfContents] + endLevel = 3 + startLevel = 1 + [markup.goldmark] + [markup.goldmark.renderer] + unsafe = true # https://jdhao.github.io/2019/12/29/hugo_html_not_shown/ + [markup.goldmark.parser] + [markup.goldmark.parser.attribute] + block = true ``` ### Install as a Git Submodule @@ -94,7 +110,7 @@ Edit the `hugo.toml` config file: baseURL = 'http://example.org/' languageCode = 'en-us' title = 'My New Hugo Site' -contentDir = "content" +contentDir = 'content' enableEmoji = true [module]