Merge branch 'release' into add-rss-atom-feed-autodiscovery

Author: colinwilson

README.md

@@ -39,9 +39,9 @@ Check out the demo site [https://lotusdocs.dev/docs/](https://lotusdocs.dev/docs
 
 ### Requirements
 
-- Hugo **Extended** (minimum version: 0.120.0)
+- Hugo **Extended** (minimum version: 0.140.0)
 - git
-- Go (minimum version v1.20)
+- Go (minimum version v1.21)
 
 ### Initialize your site as a Hugo Module
 
@@ -59,6 +59,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:
@@ -67,6 +70,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]]
@@ -75,6 +80,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
@@ -92,6 +108,8 @@ Edit the `hugo.toml` config file:
 baseURL = 'http://example.org/'
 languageCode = 'en-us'
 title = 'My New Hugo Site'
+contentDir = 'content'
+enableEmoji = true
 
 [module]
     # uncomment line below for temporary local development of module
@@ -103,6 +121,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 Locally
@@ -175,4 +204,4 @@ Navigate to `localhost:1313/docs/` and you should see a card link to the **Examp
 
 Copyright © 2022-2023 [Colin Wilson](https://github.com/colinwilson)
 
-[^1]: [Hugo Modules](https://gohugo.io/hugo-modules/)
+[^1]: [Hugo Modules](https://gohugo.io/hugo-modules/)