From ec9f508989f177b9bf812f29c7f91f437aea6865 Mon Sep 17 00:00:00 2001 From: weru <onewesh@gmail.com> Date: Thu, 08 Oct 2020 11:56:28 +0000 Subject: [PATCH] update --- exampleSite/content/docs/getting-started.md | 8 +++----- exampleSite/content/docs/clarity/getting-started.md | 6 +++--- 2 files changed, 6 insertions(+), 8 deletions(-) diff --git a/exampleSite/content/docs/clarity/getting-started.md b/exampleSite/content/docs/clarity/getting-started.md index 55dc102..d15407f 100644 --- a/exampleSite/content/docs/clarity/getting-started.md +++ b/exampleSite/content/docs/clarity/getting-started.md @@ -47,6 +47,8 @@ This option enables you to load this theme as a hugo module. It arguably requires the least effort to run and maintain in your website. +First things first, ensure you have `go` binary [installed on your machine](https://golang.org/doc/install). + ```bash git clone https://github.com/chipzoller/hugo-clarity.git clarity cd clarity/exampleSite/ @@ -60,8 +62,6 @@ hugo server ``` -> There's one drawback to this technique. Your site will always use the most up-to-date version of the theme. This might break your site if there are substantial / breaking changes that you don't like. - -You can work around this forking the repo instead and following the same approach. Be sure the edit `theme = ["github.com/chipzoller/hugo-clarity"]` from the config.toml file to `theme = ["github.com/yourUsername/hugo-clarity"]`. +To pull in theme updates, run `hugo mod get -u ./...` from the theme folder. If unsure, [learn how to update hugo modules](https://gohugo.io/hugo-modules/use-modules/#update-modules) > There [is more you could do with hugo modules](https://discourse.gohugo.io/t/hugo-modules-for-dummies/20758), but this will suffice for our use case here. diff --git a/exampleSite/content/docs/getting-started.md b/exampleSite/content/docs/getting-started.md index 0b4d001..5aae52b 100755 --- a/exampleSite/content/docs/getting-started.md +++ b/exampleSite/content/docs/getting-started.md @@ -7,7 +7,7 @@ ## Prerequisites and installation -### Install Hugo +### Install Hugo You need a [recent **extended** version](https://github.com/gohugoio/hugo/releases) (we recommend version 0.61 or later) of [Hugo](https://gohugo.io/) to do local builds and previews of sites (like this one) that uses this theme. @@ -21,7 +21,7 @@ ### Option 1 (my favorite) -This option enables you to load compose theme as a hugo module. +This option enables you to load compose theme as a hugo module. First things first, ensure you have `go` binary [installed on your machine](https://golang.org/doc/install). ```bash git clone https://github.com/onweru/compose/ @@ -29,9 +29,7 @@ hugo server ``` -> There's one drawback to this technique. Your site would always use the most up-to-date version of the theme. This might break your site if there are drastic changes that you don't like. - -You can neutralize that drawback by forking the repo instead and following the same approach. Be sure the edit the `theme = ["github.com/onweru/compose"]` from the config.toml file appropriately. +To pull in theme updates, run `hugo mod get -u ./...` from the theme folder. If unsure, [learn how to update hugo modules](https://gohugo.io/hugo-modules/use-modules/#update-modules) > ⚠️ If you choose __Option 2__ or __Option 3__ below, ensure you edit [these lines in the config.toml file](https://github.com/onweru/compose/blob/b3e30e0816621223224897edc45eeeabd0d9cd16/exampleSite/config.toml#L4-L7) as advised on the comments -- Gitblit v1.10.0