congo/exampleSite/content/docs/getting-started.md

title	date	draft	description	slug	tags
Getting Started	2020-08-15	false	All the front matter variables available in Congo.	getting-started	installation docs

{{< alert >}} This section assumes you have already [installed the Congo theme]({{< ref "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:

# config/_default/config.toml

baseURL = "https://your_domain.com"
languageCode = "en-AU"
title = "My awesome website"

[author]
name = "Your name"
image = "img/author.jpg"
links = [
  { twitter = "https://twitter.com/username" }
]

The [author] configuration determines how the author information is displayed on the website. The image should be placed in the site's static/ folder. Links will be displayed in the order they are listed.

Further detail about these configuration options is covered in the [Configuration]({{< ref "configuration" >}}) section.

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:

# config/_default/taxonomies.toml

topic = "topics"

This will replace the default tags and categories with topics. Refer to the Hugo Taxonomy docs 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:

# 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]({{< ref "configuration" >}}) section.