Skip to content

Commit

Permalink
doc: install as hugo module. close #55
Browse files Browse the repository at this point in the history
  • Loading branch information
tomowang committed Sep 24, 2024
1 parent 21ec731 commit 30bc8d4
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 2 deletions.
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
module github.com/tomowang/hugo-theme-tailwind

go 1.21.4
go 1.23.1

0 comments on commit 30bc8d4

Please sign in to comment.