mirror of https://github.com/jpanther/congo.git
74 lines
2.3 KiB
Markdown
74 lines
2.3 KiB
Markdown
|
---
|
||
|
|
title: "Getting Started"
|
||
|
|
date: 2020-08-15
|
||
|
|
draft: false
|
||
|
|
description: "All the front matter variables available in Congo."
|
||
|
|
slug: "getting-started"
|
||
|
|
tags: ["installation", "docs"]
|
||
|
|
showDate: false
|
||
|
|
showAuthor: false
|
||
|
|
---
|
||
|
|
|
||
|
|
{{< alert >}}
|
||
|
|
This section assumes you have already [installed the Congo theme](/docs/installation/).
|
||
|
|
{{< /alert >}}
|
||
|
|
|
||
|
|
The config files that ship with Congo contain all of the possible settings that the theme recognises. By default, many of these are commented out but you can simply uncomment them to activate or change a specific feature.
|
||
|
|
|
||
|
|
A few things you need to set for a new installation:
|
||
|
|
|
||
|
|
```toml
|
||
|
|
# config/_default/config.toml
|
||
|
|
|
||
|
|
baseURL = "https://your_domain.com"
|
||
|
|
languageCode = "en-AU"
|
||
|
|
|
||
|
|
title = "My awesome website"
|
||
|
|
```
|
||
|
|
|
||
|
|
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
|
||
|
|
# config/_default/author.toml
|
||
|
|
|
||
|
|
[author]
|
||
|
|
name = "Your name"
|
||
|
|
links = [
|
||
|
|
{ twitter = "https://twitter.com/username" }
|
||
|
|
]
|
||
|
|
```
|
||
|
|
|
||
|
|
## Organising content
|
||
|
|
|
||
|
|
By default, Congo doesn't force you to use a particular content type. In doing so you are free to define your content as you wish. You might prefer _pages_ for a static site, _posts_ for a blog, or _projects_ for a portfolio.
|
||
|
|
|
||
|
|
The same logic applies to taxonomies. Some people prefer to use _tags_ and _categories_, others prefer to use _topics_.
|
||
|
|
|
||
|
|
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
|
||
|
|
# config/_default/taxonomies.toml
|
||
|
|
|
||
|
|
topic = "topics"
|
||
|
|
```
|
||
|
|
|
||
|
|
This will replace the default _tags_ and _categories_ with _topics_. Refer to the [Hugo Taxonomy docs](https://gohugo.io/content-management/taxonomies/) for more information on naming taxonomies.
|
||
|
|
|
||
|
|
When you create a new taxonomy, you will need to adjust the navigation links on the website to point to the new sections:
|
||
|
|
|
||
|
|
```toml
|
||
|
|
# config/_default/menus.toml
|
||
|
|
|
||
|
|
[[main]]
|
||
|
|
name = "Blog"
|
||
|
|
pageRef = "posts"
|
||
|
|
weight = 10
|
||
|
|
|
||
|
|
[[main]]
|
||
|
|
name = "Topics"
|
||
|
|
pageRef = "topics"
|
||
|
|
weight = 20
|
||
|
|
```
|
||
|
|
|
||
|
|
These steps are the bare minimum configuration. If you now run `hugo server` you will be presented with a blank Congo website. Detailed configuration is covered in the [Configuration](/docs/configuration/) section.
|