From 67b804c704de0528cf457ffe741c90d22b0f2488 Mon Sep 17 00:00:00 2001 From: James Panther <4462786+jpanther@users.noreply.github.com> Date: Thu, 19 Aug 2021 14:40:57 +1000 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Add=20instructions=20for=20Hugo?= =?UTF-8?q?=20Modules=20installation?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CHANGELOG.md | 3 +- README.md | 40 +++++++++++++-- exampleSite/content/_index.md | 4 +- exampleSite/content/docs/installation.md | 64 ++++++++++++++++++++---- 4 files changed, 94 insertions(+), 17 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index ac0f02f1..2bbc97f5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -12,7 +12,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), ### Fixed -- Fix style issue with `button` shortcode +- Minor style issue with `button` shortcode +- Hugo Modules would fail when using default theme config file ## [1.1.1] - 2020-08-19 diff --git a/README.md b/README.md index da88aefd..23450493 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,28 @@ Congo is designed to be a simple, lightweight theme for [Hugo](https://gohugo.io This is a simplified set of instructions and assumes a basic understanding of building Hugo sites and installing themes. For detailed instructions, refer to the full [theme documentation](https://jpanther.github.io/congo/docs/). -There are a couple of ways to install the Congo theme into your Hugo website. The git method is the easiest to keep the theme up-to-date, but you can also download and install manually if you don't have git available. +There are a few ways to install the Congo theme into your Hugo website. + +### Install using Hugo + +This method is the quickest and easiest for keeping the theme up-to-date. Hugo Modules uses Go to initialise and manage modules so you need to ensure you have Go installed before proceeding. + +1. [Download](https://golang.org/dl/) and install Go. You can check if it's already installed by using the command `go version`. +2. From your Hugo project's directory, initiate the Hugo Modules system for your website: + + ```shell + hugo mod init github.com// + ``` + +3. Add the theme to your configuration by creating a new file `config/_default/module.toml` and adding the following: + + ```toml + [[imports]] + path = "github.com/jpanther/congo" + ``` + +4. Start your server using `hugo server` and the theme will be downloaded automatically. +5. Continue to [set up the theme configuration files](#set-up-theme-configuration-files). ### Install using git @@ -48,15 +69,26 @@ git init git submodule add -b stable https://github.com/jpanther/congo.git themes/congo ``` +Then continue to [set up the theme configuration files](#set-up-theme-configuration-files). + ### Install manually -Download the latest release of the theme from: [https://github.com/jpanther/congo/releases](https://github.com/jpanther/congo/releases) +Download the latest release of the theme from: [https://github.com/jpanther/congo/releases/latest](https://github.com/jpanther/congo/releases/latest) Extract the archive, rename the folder to `congo` and move it to the `themes/` directory inside your Hugo project. -### Set up your configuration files +Then continue to [set up the theme configuration files](#set-up-theme-configuration-files). -In the root folder of your website, delete the `config.toml` file that was generated by Hugo. Copy the entire `config` folder from `themes/congo/config/` into the root of your website. This will ensure you have all the correct theme settings and will enable you to easily customise the theme. +### Set up theme configuration files + +In the root folder of your website, delete the `config.toml` file that was generated by Hugo. Copy the `*.toml` config files from the theme into your `config/_default/` folder. This will ensure you have all the correct theme settings and will enable you to easily customise the theme. + +Depending on how you installed the theme you will find the theme config files in different places: + +- **Hugo Modules:** In the Hugo cache directory, or [download a copy](https://minhaskamal.github.io/DownGit/#/home?url=https://github.com/jpanther/congo/tree/stable/config/_default) from GitHub +- **Git submodule or Manual install:** `themes/congo/config/_default` + +> **Important:** If you didn't use Hugo Modules to install Congo, you must add the line `theme = "congo"` to the top of your `config.toml` file. You're now all set up to use Congo. From here you can add some content and start the Hugo server. diff --git a/exampleSite/content/_index.md b/exampleSite/content/_index.md index eb5d9649..5c4ceb2a 100755 --- a/exampleSite/content/_index.md +++ b/exampleSite/content/_index.md @@ -7,14 +7,14 @@ description: "This is a demo of the Congo theme for Hugo." A simple, lightweight theme for Hugo built with Tailwind CSS. {{< /lead >}} -
+
{{< icon "exclamation-triangle" >}} This is a demo of the page layout.