Merge pull request #365 from paskal/go_mod

Add instructions about installing theme as a hugo module
xianmin · Dec 3, 2023 · baf819e · baf819e
2 parents e13946c + 35b38cd
commit baf819e
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -56,6 +56,19 @@ cd myBlog
 git clone https://github.com/xianmin/hugo-theme-jane.git --depth=1 themes/jane
 ```
 
+<details>
+<summary>Alternative, installation as a module</summary>
+
+If you have [Go](https://go.dev/) installed you can install the theme as a [hugo module](https://gohugo.io/hugo-modules/), then there will be no need to clone it into the `themes` folder:
+
+```bash
+hugo mod init example.com/my-blog
+```
+
+After that, you would need to use `github.com/xianmin/hugo-theme-jane` as your `theme` and not `hugo-theme-jane` in your `config.toml` file.
+
+</details>
+
 Copy the example site content:
 
 ```bash

diff --git a/go.mod b/go.mod
@@ -0,0 +1,3 @@
+module github.com/xianmin/hugo-theme-jane
+
+go 1.21.0
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		module github.com/xianmin/hugo-theme-jane

		go 1.21.0