Skip to content

Commit

Permalink
Added prerequisites for content creation.
Browse files Browse the repository at this point in the history
Added configuration options for the hugo module and added Prerequistes section to create the content directory.
  • Loading branch information
laundry-96 committed Oct 27, 2023
1 parent ad3af3b commit 826a3b6
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion README.md
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,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]
Expand Down

0 comments on commit 826a3b6

Please sign in to comment.