summaryrefslogtreecommitdiffstats
path: root/exampleSite/content/documentation/index.md
diff options
context:
space:
mode:
authorSerghei Iakovlev <egrep@protonmail.ch>2022-07-09 13:26:58 +0200
committerGitHub <noreply@github.com>2022-07-09 13:26:58 +0200
commit0942efbdf7fb3573517b2f7e52803c3982529caf (patch)
tree26582d034e4e3449c403fe5e0b9a80283dec2948 /exampleSite/content/documentation/index.md
parent46e8edfce3738ea14388546ac8690144b7633bb3 (diff)
parentb3c39de2e5265cb81d0268d08c0cd4cb47a93f0d (diff)
downloadgohugo-theme-ed-0942efbdf7fb3573517b2f7e52803c3982529caf.tar.gz
Merge pull request #10 from sergeyklay/feature/update-config
Update config for exampleSite
Diffstat (limited to 'exampleSite/content/documentation/index.md')
-rw-r--r--exampleSite/content/documentation/index.md16
1 files changed, 7 insertions, 9 deletions
diff --git a/exampleSite/content/documentation/index.md b/exampleSite/content/documentation/index.md
index 4989b86..eac5c9c 100644
--- a/exampleSite/content/documentation/index.md
+++ b/exampleSite/content/documentation/index.md
@@ -26,22 +26,20 @@ Please note, to install Ed, you must have [Go >= 1.12](https://golang.org/dl/) i
$ go version
~~~
-If you don't get an error, you're good to go. Using the `cd` command on your terminal, navigate to the folder where you keep your web projects. Once you're in the folder where project live, initialize the Hugo Module system using the following line (replace `<your_user>` and `<your_project>` by real names):
+If you don't get an error, you're good to go. Using the `cd` command on your terminal, navigate to the folder where you keep your web projects. Once you're in the folder where project live, initialize the [Hugo Modules](https://gohugo.io/hugo-modules) system using the following line (replace `<your_user>` and `<your_project>` by real names):
~~~ bash
$ hugo mod init github.com/<your_user>/<your_project>
~~~
-Take a look inside the [`exampleSite`](https://github.com/sergeyklay/gohugo-theme-ed/tree/master/exampleSite) folder of this theme. You'll find a file called [`config.toml`](https://github.com/sergeyklay/gohugo-theme-ed/blob/master/exampleSite/config.toml). To use it, copy the [`config.toml`](https://github.com/sergeyklay/gohugo-theme-ed/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/sergeyklay/gohugo-theme-ed/tree/master/exampleSite) folder of this theme. You'll find a folder called [`config`](https://github.com/sergeyklay/gohugo-theme-ed/blob/master/exampleSite/config). Copy the [`config`](https://github.com/sergeyklay/gohugo-theme-ed/blob/master/exampleSite/config) folder in the project root of your Hugo site. Check the contents of the `config` folder and configure it.
-You will need to delete the following line: `resourceDir = '../resources'`, because it's necessary only for theme developers.
+After that, import the theme adding the following lines to `config/_default/config.yaml`:
-After that, import the theme adding the following lines to `config.yaml`:
-
-~~~ toml
-[module]
-[[module.imports]]
- path = 'github.com/sergeyklay/gohugo-theme-ed'
+~~~ yaml
+module:
+ imports:
+ - path: github.com/sergeyklay/gohugo-theme-ed
~~~
Finally, install Hugo Modules using the following command (remember you can copy and paste):