Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/Lednerb/bilberry-hugo-theme.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorIgor Baiborodine <igor@kiroule.com>2022-05-31 18:28:16 +0300
committerIgor Baiborodine <igor@kiroule.com>2022-05-31 18:28:16 +0300
commitc96c582aafc61299bba2706c19a20878c3f0c7ee (patch)
treeaafc43f083d5005925e4e18d1e171d2520a4c211
parent642ae7f5a64af6fd7693530483084fbc83a099c4 (diff)
Update README.md
-rw-r--r--README.md27
1 files changed, 15 insertions, 12 deletions
diff --git a/README.md b/README.md
index 23c297d..0192abf 100644
--- a/README.md
+++ b/README.md
@@ -29,7 +29,7 @@ Please use the following guidelines if you want to start a discussion:
- [Quick Start](#quick-start)
- [Site Initial Setup](#site-initial-setup)
- [Theme Installation Options](#theme-installation-options)
- - [Option 1(recommended): Adding the Theme as a Hugo Module](#option-1recommended-adding-the-theme-as-a-hugo-module)
+ - [Option 1(recommended): Adding the Theme as a Hugo Module](#option-1-recommended-adding-the-theme-as-a-hugo-module)
- [Option 2: Cloning/Copying the Theme Files](#option-2-cloningcopying-the-theme-files)
- [Configuration](#configuration)
- [Webserver](#webserver)
@@ -110,28 +110,31 @@ rm my-new-blog/archetypes/default.md
```
### Theme Installation Options
-#### Option 1(recommended): Adding the Theme as a Hugo Module
-Use this option if you want to pull in the theme files from the main Bilberry Hugo theme repository at your chosen revision.
+#### Option 1 (recommended): Adding the Theme as a Hugo Module
+Use this option if you want to pull in the theme files from the main Bilberry Hugo theme repository at your chosen revision.
This option makes it easy to keep the theme up to date on your site.
-- In the `my-new-blog/config.toml` file, uncomment the `theme` property for **Option 1**, and comment out the `theme` property for **Option 2**:
-```toml
-# Option 1(recommended): Adding the Theme as a Hugo Module
-theme = "github.com/Lednerb/bilberry-hugo-theme/v3"
-
-# Option 2: Cloning/Copying the Theme Files
-# theme = "bilberry-hugo-theme"
-```
-
- Initialize your website as a Hugo module from the site's root:
```shell
cd my-new-blog
hugo mod init github.com/<your-user>/my-new-blog
```
+Following the Hugo module initialization, you may have the following warning: module "github.com/Lednerb/bilberry-hugo-theme/v3" not found, which should be ignored.
+
+If you need more details on how to use Hugo modules, please read the [Hugo documentation](https://gohugo.io/hugo-modules/use-modules/).
#### Option 2: Cloning/Copying the Theme Files
Use this option if you want to directly customize and maintain your own copy of the theme.
+- In the `my-new-blog/config.toml` file, uncomment the `theme` property for **Option 2**, and comment out the `theme` property for **Option 1**:
+```toml
+# Option 1 (recommended): Adding the Theme as a Hugo Module
+# theme = "github.com/Lednerb/bilberry-hugo-theme/v3"
+
+# Option 2: Cloning/Copying the Theme Files
+theme = "bilberry-hugo-theme"
+```
+
- Copy cloned(or unzipped) theme files in previous step to the `my-new-blog/themes` directory:
```shell
cp -r bilberry-hugo-theme my-new-blog/themes/bilberry-hugo-theme