diff options
author | Andreas Deininger <andreas@deininger.net> | 2022-01-14 14:11:02 +0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-01-14 14:11:02 +0300 |
commit | fcbc65c81ceb7ff31879e997026d79e5215f7b90 (patch) | |
tree | 8712f0b2cb9d210e0c521ebf1eb8bd1431ad295b /README.md | |
parent | 99baec23d388f6693495c90e864629bada902258 (diff) |
feat: turn anatole theme into a hugo module (#291)
* Turn anatole theme into a hugo module
* Add documentation on using theme as module
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 34 |
1 files changed, 31 insertions, 3 deletions
@@ -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 |