From your Hugo project directory (that you created above), initialise modules for your website:
Depending on how you installed the theme you will find the theme config files in different places:
config/_default/
+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 *.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 to your needs.
Note: You should not overwrite the module.toml
file if one already exists in your project! 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 from GitHub
- Git submodule or Manual install:
themes/congo/config/_default
Once you’ve copied the files, your config folder should look like this:
config/_default/
├─ config.toml
├─ markup.toml
├─ menus.toml
├─ module.toml # if you installed using Hugo Modules
└─ params.toml
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. Next steps #
The basic Congo installation is now complete. Continue to the
-Getting Started section to learn more about configuring the theme.
Installing updates #
From time to time there will be
-new releases posted that apply fixes and add new functionality to the theme. In order to take advantage of these changes, you will need to update the theme files on your website.
How you go about this will depend on the installation method you chose when the theme was originally installed. Instructions for each method can be found below.
Update using Hugo #
Hugo makes updating modules super easy. Simply change into your project directory and execute the following command:
hugo mod get -u
+Getting Started section to learn more about configuring the theme.
Installing updates #
From time to time there will be new releases posted that apply fixes and add new functionality to the theme. In order to take advantage of these changes, you will need to update the theme files on your website.
How you go about this will depend on the installation method you chose when the theme was originally installed. Instructions for each method can be found below.
Update using Hugo #
Hugo makes updating modules super easy. Simply change into your project directory and execute the following command:
Hugo will automatically update any modules that are required for your project. It does this by inspecting your module.toml
and go.mod
files. If you have any issues with the update, check to ensure these files are still configured correctly.
Then simply rebuild your site and check everything works as expected.
When updating modules, sometimes Hugo will cache an older version of the theme. If this happens, clear your local cache by using the hugo mod clean
command and then rebuild your site. Update using git #
Git submodules can be updated using the git
command. Simply execute the following command and the latest version of the theme will be downloaded into your local repository:
git submodule update --remote --merge
Once the submodule has been updated, rebuild your site and check everything works as expected.
Update manually #
Updating Congo manually requires you to download the latest copy of the theme and replace the old version in your project.
Note that any local customisations you have made to the theme files will be lost during this process. Download the latest release of the theme source code.
Download from GithubExtract the archive, rename the folder to congo
and move it to the themes/
directory inside your Hugo project’s root folder. You will need to overwrite the existing directory to replace all the theme files.
Rebuild your site and check everything works as expected.