Skip to content

Commit 422ba83

Browse files
docs(v4): add "Theme installation options" section in migration guide. (#555)
1 parent 43c56f5 commit 422ba83

File tree

2 files changed

+14
-2
lines changed

2 files changed

+14
-2
lines changed

v4-migration-guide.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,18 @@
33
**IMPORTANT** The Hugo version was bumped to `v0.109.0 extended`. Therefore, you should upgrade Hugo in your local
44
development environment and, if necessary, in the corresponding deployment configuration file.
55

6+
### Theme Installation Options
7+
8+
Depending on your chosen theme installation option, update the theme property in the `config.toml` file as follows:
9+
10+
```toml
11+
# Option 1 (recommended) : adding the theme as a Hugo module
12+
theme = "github.com/Lednerb/bilberry-hugo-theme/v4"
13+
14+
# Options 2 and 3: cloning/copying the theme files
15+
theme = "bilberry-hugo-theme/v4"
16+
```
17+
618
### Top Navigation Bar
719

820
1. Remove completely the `excludeFromTopNav` variable from all content files in the `content/page` folder.

v4/exampleSite/config.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ baseURL = "https://example.com/"
44
# Option 1 (recommended): adding the theme as a Hugo module
55
theme = "github.com/Lednerb/bilberry-hugo-theme/v4"
66

7-
# Option 2: cloning/copying the theme files
7+
# Options 2 and 3: cloning/copying the theme files
88
# theme = "bilberry-hugo-theme/v4"
99

1010
# Generate the robots.txt file for SEO
@@ -20,7 +20,7 @@ googleAnalytics = ""
2020
disqusShortname = ""
2121

2222
[params]
23-
# Custom CSS / JS modules that will be imported by the template.
23+
# Custom CSS/JS modules that will be imported by the template.
2424
# Files are relative to the static/ directory or a URL.
2525
# Files are imported in the order they appear here, after
2626
# theme.css and theme.js, respectively.

0 commit comments

Comments
 (0)