From e5c72703a0b4d40e8155f8b56a26ea4a21e4ec7b Mon Sep 17 00:00:00 2001 From: Ivan Boothe Date: Tue, 17 May 2022 16:02:19 -0700 Subject: fix formatting Signed-off-by: Ivan Boothe --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 576ca69..aa48cf5 100644 --- a/README.md +++ b/README.md @@ -138,17 +138,21 @@ This option arguably requires the least effort to run and maintain your website We assume you've already run `hugo new site ` and are in the `` directory. -1. Ensure you have the `go` binary [installed on your machine](https://golang.org/doc/install) Note: Mac users: ```brew install go```. -2. Run the following command, substituting `` with your site's name: +1. Ensure you have the `go` binary [installed on your machine](https://golang.org/doc/install). (Mac users: ```brew install go```.) + +2. Run the following command: ```bash hugo mod init ``` + 3. Hugo Clarity comes with [`exampleSite` files](https://github.com/chipzoller/hugo-clarity/tree/master/exampleSite) prefilled with helpful configuration and sample posts. If you're starting a new Hugo site and don't have any content yet, it's easiest to grab the whole thing: ```bash wget -O - https://github.com/chipzoller/hugo-clarity/archive/master.tar.gz | tar xz && cp -a hugo-clarity-master/exampleSite/* . && rm -rf hugo-clarity-master && rm -f config.toml ``` If you do already have a site and don't want to risk overwriting anything, we suggest copying the contents of [`config`](exampleSite/config/) over, as well as replacing your `archetypes/post.md` (if it exists) with [Hugo Clarity's](exampleSite/archetypes/post.md). Then migrate any necessary settings from `/config.toml` to `/config/_default/config.toml` and remove the original `/config.toml` file. + 4. Open `/config/_default/config.toml` and change `theme = "hugo-clarity"` to `theme = ["github.com/chipzoller/hugo-clarity"]` + 5. You can now run: ```bash hugo server -- cgit v1.2.3