Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/budparr/gohugo-theme-ananke.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRegis Philibert <login@regisphilibert.com>2020-09-03 23:32:00 +0300
committerRegis Philibert <login@regisphilibert.com>2020-09-03 23:32:00 +0300
commitaf7976ea28640bdb29155253cf9d78983036bda9 (patch)
tree4c01d5a3947e74698122c7938813cbcaf4a81d8a
parent03fd7d9da05db0928284b601d987c97556c6eb24 (diff)
Update readme for usage as Hugo Module
-rw-r--r--README.md22
1 files changed, 17 insertions, 5 deletions
diff --git a/README.md b/README.md
index 6dfdedd..6b6f7be 100644
--- a/README.md
+++ b/README.md
@@ -49,10 +49,22 @@ This theme uses the "Tachyons" CSS library. This will allow you to manipulate th
## Installation
-Inside the folder of your Hugo site run:
+### As a Hugo Module (recommanded)
+
+Simply add the repo to your theme option:
+
+```yaml
+theme:
+ - github.com/theNewDynamic/gohugo-theme-ananke
+```
- $ git submodule add https://github.com/budparr/gohugo-theme-ananke.git themes/ananke
+### As Git Submodule
+Inside the folder of your Hugo site run:
+
+```
+$ git submodule add https://github.com/theNewDynamic/gohugo-theme-ananke.git themes/ananke
+```
For more information read the official [setup guide](//gohugo.io/overview/installing/) of Hugo.
@@ -64,7 +76,7 @@ After installing the theme successfully it requires a just a few more steps to g
### The config file
-Take a look inside the [`exampleSite`](https://github.com/budparr/gohugo-theme-ananke/tree/master/exampleSite) folder of this theme. You'll find a file called [`config.toml`](https://github.com/budparr/gohugo-theme-ananke/blob/master/exampleSite/config.toml). To use it, copy the [`config.toml`](https://github.com/budparr/gohugo-theme-ananke/blob/master/exampleSite/config.toml) in the root folder of your Hugo site. Feel free to change the strings in this theme.
+Take a look inside the [`exampleSite`](https://github.com/theNewDynamic/gohugo-theme-ananke/tree/master/exampleSite) folder of this theme. You'll find a file called [`config.toml`](https://github.com/theNewDynamic/gohugo-theme-ananke/blob/master/exampleSite/config.toml). To use it, copy the [`config.toml`](https://github.com/theNewDynamic/gohugo-theme-ananke/blob/master/exampleSite/config.toml) in the root folder of your Hugo site. Feel free to change the strings in this theme.
You may need to delete the line: `themesDir = "../.."`
@@ -181,11 +193,11 @@ hugo
## Contributing
-If you find a bug or have an idea for a feature, feel free to use the [issue tracker](https://github.com/budparr/gohugo-theme-ananke/issues) to let me know.
+If you find a bug or have an idea for a feature, feel free to use the [issue tracker](https://github.com/theNewDynamic/gohugo-theme-ananke/issues) to let me know.
TODO:
-- fix hard-coded link to [section](https://github.com/budparr/gohugo-theme-ananke/blob/master/layouts/index.html#L32)
+- fix hard-coded link to [section](https://github.com/theNewDynamic/gohugo-theme-ananke/blob/master/layouts/index.html#L32)