From 30bc8d43afc632e6d9a8476c1431ccc04211088e Mon Sep 17 00:00:00 2001 From: Tomo Wang Date: Tue, 24 Sep 2024 23:49:55 +0800 Subject: [PATCH] doc: install as hugo module. close #55 --- README.md | 17 ++++++++++++++++- go.mod | 2 +- 2 files changed, 17 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5be0dcd..d94ea7f 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,9 @@ Check [https://hugo-theme-tailwind.tomo.dev/](https://hugo-theme-tailwind.tomo.d ## Installation -### Git +You can install the theme by using git submodule or hugo module. + +### Git Submodule Add the theme as a submodule by running the following command in the root directory of your Hugo site: @@ -44,6 +46,19 @@ git submodule add https://github.com/tomowang/hugo-theme-tailwind.git themes/tai git submodule update --remote ``` +### Hugo Module + +1. First, initialize module for your Hugo site: `hugo mod init github.com/username/xxxx` +2. Then, add module import in your `hugo.toml`: + +```toml +[module] + [[module.imports]] + path = "github.com/tomowang/hugo-theme-tailwind" +``` + +3. Finally, run `hugo mod get -u` to download the theme. + ## Configuration You can use the following configuration for basic usage. diff --git a/go.mod b/go.mod index 90e949e..e89fb0d 100644 --- a/go.mod +++ b/go.mod @@ -1,3 +1,3 @@ module github.com/tomowang/hugo-theme-tailwind -go 1.21.4 +go 1.23.1