diff --git a/README.md b/README.md index cfc2ae1..d21a21f 100644 --- a/README.md +++ b/README.md @@ -130,7 +130,9 @@ Hugo Extended version 0.93.0 or higher is required. ### Hugo module -First of all, you need to turn your new or existing site into a hugo module. +You need to have `go` installed to use Hugo modules. + +Turn your new or existing site into a hugo module. From the root of your site: @@ -138,15 +140,15 @@ From the root of your site: hugo mod init github.com/me/my-site ``` -Afterwards, declare the `zen` theme module as a dependency of your site: +Then set the "theme" setting to "github.com/frjo/hugo-theme-zen/v3". From the root of your site: ```shell -hugo mod get -u github.com/frjo/hugo-theme-zen/v3 +hugo mod get -u ``` -### Git submodule +### Git clone You can download and unpack the theme manually from Github but it's easier to use git to clone the repo. @@ -156,6 +158,10 @@ From the root of your site: git clone https://github.com/frjo/hugo-theme-zen.git themes/zen ``` +Then set the "theme" setting to "zen". + +### Git submodule + If you use git to version control your site you can add the zen theme as a submodule. From the root of your site: @@ -164,6 +170,7 @@ From the root of your site: git submodule add https://github.com/frjo/hugo-theme-zen.git themes/zen ``` +Then set the "theme" setting to "zen". ## Updating @@ -172,7 +179,7 @@ git submodule add https://github.com/frjo/hugo-theme-zen.git themes/zen From the root of your site: ```shell -hugo mod get -u github.com/frjo/hugo-theme-zen +hugo mod get -u ``` ### Git submodule @@ -217,11 +224,6 @@ Some performance tools will complain about to many files (js and css files are n * [xdeb.net](https://xdeb.net/) -## Nice forks of the Zen theme - -* [DFD-Zen theme for Hugo](https://gitlab.com/danielfdickinson/dfd-hugo-theme-zen) - - ## Screenshots ![screenshot](https://raw.githubusercontent.com/frjo/hugo-theme-zen/main/images/tn.png) @@ -413,6 +415,8 @@ Example render hook that process images in the same way as the "img" shortcode. Example render hook to rewrite external links so they open in a new tab. To activate it copy the file `~/theme/zen/layouts/_default/_markup/render-link.html.example` to `layouts/_default/_markup/render-link.html`. +I rarely use this one, I think the user should decide how links open. + ## Multilingual A language selector will be included on sites with more than one language. Add `languageName` to your language configuration, this is what will be displayed in the selector. diff --git a/theme.toml b/theme.toml index fad1912..8cd8cab 100644 --- a/theme.toml +++ b/theme.toml @@ -1,5 +1,5 @@ name = "Zen" -description = "A solid base for your custom Hugo theme with pipes support for Sass and Javascript." +description = "A solid base for your custom Hugo theme. Care has been taken to produce semantic and accessible code." homepage = "https://github.com/frjo/hugo-theme-zen" demosite = "https://zen-demo.xdeb.org/" license = "GPLv2"