Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Added more defaults for hugo.toml #124

Open
wants to merge 2 commits into
base: release
Choose a base branch
from
Open

Added more defaults for hugo.toml #124

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ad3af3b
Added more defaults for hugo.toml
laundry-96 Oct 27, 2023
826a3b6
Added prerequisites for content creation.
laundry-96 Oct 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 30 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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]]
Expand All @@ -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
Expand All @@ -94,6 +110,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 @@ -105,6 +123,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 @@ -177,4 +206,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/)