Skip to content

Commit 034829a

Browse files
authored
Added more defaults for hugo.toml (#124)
This is great. Sorry it took so long to get round to merging this. Thanks for your contribution 👍
2 parents 8bb3836 + 5a2da67 commit 034829a

File tree

1 file changed

+30
-1
lines changed

1 file changed

+30
-1
lines changed

README.md

+30-1
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,9 @@ The Lotus Docs theme can be installed using one of the following methods:
5959
- As a Git submodule
6060
- Clone the theme files locally
6161

62+
Prerequisites:
63+
- `contentDir` present in project folder
64+
6265
### Install as a Hugo Module (recommended)
6366

6467
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:
6770
baseURL = 'http://example.org/'
6871
languageCode = 'en-us'
6972
title = 'My New Hugo Site'
73+
contentDir = 'content'
74+
enableEmoji = true
7075

7176
[module]
7277
[[module.imports]]
@@ -75,6 +80,17 @@ title = 'My New Hugo Site'
7580
[[module.imports]]
7681
path = "github.com/gohugoio/hugo-mod-bootstrap-scss/v5"
7782
disable = false
83+
84+
[markup]
85+
[markup.tableOfContents]
86+
endLevel = 3
87+
startLevel = 1
88+
[markup.goldmark]
89+
[markup.goldmark.renderer]
90+
unsafe = true # https://jdhao.github.io/2019/12/29/hugo_html_not_shown/
91+
[markup.goldmark.parser]
92+
[markup.goldmark.parser.attribute]
93+
block = true
7894
```
7995

8096
### Install as a Git Submodule
@@ -92,6 +108,8 @@ Edit the `hugo.toml` config file:
92108
baseURL = 'http://example.org/'
93109
languageCode = 'en-us'
94110
title = 'My New Hugo Site'
111+
contentDir = 'content'
112+
enableEmoji = true
95113

96114
[module]
97115
# uncomment line below for temporary local development of module
@@ -103,6 +121,17 @@ title = 'My New Hugo Site'
103121
[[module.imports]]
104122
path = "github.com/gohugoio/hugo-mod-bootstrap-scss/v5"
105123
disable = false
124+
125+
[markup]
126+
[markup.tableOfContents]
127+
endLevel = 3
128+
startLevel = 1
129+
[markup.goldmark]
130+
[markup.goldmark.renderer]
131+
unsafe = true # https://jdhao.github.io/2019/12/29/hugo_html_not_shown/
132+
[markup.goldmark.parser]
133+
[markup.goldmark.parser.attribute]
134+
block = true
106135
```
107136

108137
### Install Locally
@@ -175,4 +204,4 @@ Navigate to `localhost:1313/docs/` and you should see a card link to the **Examp
175204

176205
Copyright © 2022-2023 [Colin Wilson](https://github.com/colinwilson)
177206

178-
[^1]: [Hugo Modules](https://gohugo.io/hugo-modules/)
207+
[^1]: [Hugo Modules](https://gohugo.io/hugo-modules/)

0 commit comments

Comments
 (0)