Skip to content

Commit

Permalink
Added more defaults for hugo.toml (#124)
Browse files Browse the repository at this point in the history
This is great. Sorry it took so long to get round to merging this. Thanks for your contribution 👍
  • Loading branch information
colinwilson authored Jan 28, 2025
2 parents 8bb3836 + 5a2da67 commit 034829a
Showing 1 changed file with 30 additions and 1 deletion.
31 changes: 30 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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]]
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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/)

0 comments on commit 034829a

Please sign in to comment.