Skip to content

Commit

Permalink
Add documentation on using theme as module
Browse files Browse the repository at this point in the history
  • Loading branch information
deining committed Jan 8, 2022
1 parent 6163dbd commit bf28e4f
Showing 1 changed file with 31 additions and 3 deletions.
34 changes: 31 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,13 +52,41 @@ hugo server --themesDir ../..

## Quick Start

### Route 1 (recommended): use theme as Hugo module

1. Install prerequisites [git](https://git-scm.com/downloads) and [go](https://go.dev/dl/) (>= 1.12)
2. Turn your Hugo Project into a Hugo module: `hugo mod init github.com/me/my-project`
3. Declare the `Anatole` module as a dependency of your site: `hugo mod get github.com/lxndrblz/anatole`
4. Add the following lines at the end of your `config.toml`:

```
[module]
# uncomment line below for temporary local development of module
# replacements = "github.com/lxndrblz/anatole -> ../../anatole"
[[module.imports]]
path = "github.com/lxndrblz/anatole"
disable = false
```
### Route 2 (traditional): install theme as Git submodule

1. Add the repository into your Hugo Project repository as a submodule: `git submodule add https://github.com/lxndrblz/anatole.git themes/anatole`.
2. Configure your `config.toml`. Feel free to copy the demo `config.toml` and some content from the exampleSite.
3. Build your site with `hugo serve` and admire the result at `http://localhost:1313/`.

### Start up your site

1. Configure your `config.toml`. Feel free to copy the demo `config.toml` and some content from the exampleSite.
2. Build your site with `hugo serve` and admire the result at `http://localhost:1313/`.

## Update your installation

If you want to get the latest update of the `Anatole` theme, please execute this command:
If you want to get the latest update of the `Anatole` theme, please follow the instructions below:

### Theme as Hugo module

```shell
hugo mod get -u github.com/lxndrblz/anatole
```

### Theme as Git submodule

```shell
git submodule update --remote --merge
Expand Down

0 comments on commit bf28e4f

Please sign in to comment.