marcel
/
congo
mirror of https://github.com/jpanther/congo.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

📝 Update README

pull/2/head
James Panther 2021-08-12 18:33:42 +10:00
parent 8191f67c3b
commit 3b19231134
No known key found for this signature in database
GPG Key ID: D36F789E45745D17
1 changed files with 8 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -59,9 +59,9 @@ Rename the folder to `congo` and move it to the `themes/` directory inside your
_**Note:** You need to substitute `mywebsite` for the correct folder name you used in Step 2._ _**Note:** You need to substitute `mywebsite` for the correct folder name you used in Step 2._
### 4. Add Congo to your configuration file ### 4. Set up your configuration files
Open the `config.toml` file in the root of your website and add `theme = "congo"` In the root folder of your website, delete the `config.toml` file that was generated by Hugo. Copy the entire `themes/congo/config/` folder 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.
You're now all set up to use Congo. From here you can add some content and start the Hugo server. You're now all set up to use Congo. From here you can add some content and start the Hugo server.
@ -75,7 +75,7 @@ The theme ships with a default configuration that gets you up and running with a
> Configuration files bundled with the theme are provided in TOML format as this is the default Hugo syntax. Feel free to convert your config to YAML or JSON as you wish. > Configuration files bundled with the theme are provided in TOML format as this is the default Hugo syntax. Feel free to convert your config to YAML or JSON as you wish.
The default theme configuration can be overridden on a per-setting basis by copying the relevant setting from the `themes/congo/config/_default/` to your `config.toml` file in the root of your website. Any settings in your config file will take precedence over the theme defaults. The default theme configuration is documented in each file so you can freely adjust the settings to meet your needs.
### Getting started ### Getting started
@ -84,19 +84,18 @@ The config files that ship with Congo contain all of the possible settings that
A few things you need to set for a new installation: A few things you need to set for a new installation:
```toml ```toml
# config.toml # config/_default/config.toml
theme = "congo"
baseURL = "https://your_domain.com" baseURL = "https://your_domain.com"
languageCode = "en-AU" languageCode = "en-AU"
title = "My awesome website" title = "My awesome website"
``` ```
It's also useful to add an author configuration by copying the settings from the `themes/congo/config/_default/author.toml` file. You can also add links to your profiles here to enable them in the theme. It's also useful to set the author configuration in the `config/_default/author.toml` file. You can also add links to your profiles here to enable them in the theme.
```toml ```toml
# config.toml # config/_default/author.toml
[author] [author]
name = "Your name" name = "Your name"
@ -112,9 +111,8 @@ The same logic applies to taxonomies. Some people prefer to use _tags_ and _cate
Hugo defaults to using posts, tags and categories out of the box and this will work fine if that's what you want. If you wish to customise this, however, you can do so by creating the following files: Hugo defaults to using posts, tags and categories out of the box and this will work fine if that's what you want. If you wish to customise this, however, you can do so by creating the following files:
```toml ```toml
# config.toml # config/_default/taxonomies.toml
[taxonomies]
topic = "topics" topic = "topics"
``` ```
@ -123,7 +121,7 @@ This will replace the default _tags_ and _categories_ with _topics_. Refer to th
When you create a new taxonomy, you will need to adjust the navigation links on the website to point to the new sections: When you create a new taxonomy, you will need to adjust the navigation links on the website to point to the new sections:
```toml ```toml
# config.toml # config/_default/menus.toml
[[menu.main]] [[menu.main]]
name = "Blog" name = "Blog"