Get Started
Table of Contents
Welcome!
This page will help you:
- Understand hugo.toml and Front Matter, which you will use frequently in Hugo.
- Learn this documentation’s format conventions: site‑wide configuration uses TOML; Front Matter uses YAML.
- Complete three steps in order: install the theme → publish a post → basic & detailed configuration.
What is hugo.toml
hugo.toml
is the site‑wide configuration file. It covers languages, navigation menus, themes, and advanced features.- Many options built into Hugo are structural (rather than visual). For that reason, the Neso theme adds options for customization (for example Tailwind integration, syntax highlighting, menus, etc.).
- In earlier projects the config filename was often config, such as config.toml. Today it is recommended to use a single file hugo.toml at the project root.
- TOML is a format commonly used for configuration files. In this documentation, whenever we discuss site‑wide configuration, we demonstrate it in TOML.
TOML looks like this:
baseURL = "https://example.org/"
languageCode = "en-us"
title = "My Site Title"
# Example: select the theme
theme = "hugo-neso"
Note
For complete required and recommended settings, subsequent pages provide detailed explanations and links.
What is Front Matter
- Front Matter is the metadata at the top of each Markdown file. It describes the title, date, taxonomies, summary, etc.
- Many options built into Hugo are basic metadata. For that reason, the Neso theme adds options for better content presentation (for example cover image, ToC, share buttons, etc.).
- Hugo supports TOML, YAML, and JSON.
- Like TOML above, YAML is simply another serialization format. In this documentation, whenever we discuss Front Matter, we demonstrate it in YAML.
YAML Front Matter looks like this:
---
title : "Post title"
date : 2025-10-11T12:00:00+08:00
description : "A short SEO‑friendly description"
summary : "The summary shown on list pages"
tags : ["essay", "notes"]
---
Note
For additional Front Matter options provided by Neso to enrich your content, later pages will provide detailed explanations and links.
Start here
Follow these steps in order; each has a dedicated guide.
Install the theme Go to: Theme Installation Goal: install Neso theme and integrate Tailwind CSS to your Hugo project correctly.
Publish your first post Go to: Create a Post Goal: learn to manage a post and its assets as a “leaf bundle”, and apply the recommended Front Matter.
Complete the basic configuration Go to: Basic Configuration Goal: adjust the required and recommended hugo.toml parameters so the site behaves and looks correct.
Next steps
- Browse other documentation pages to fine‑tune details: pages and menu setup, shortcodes, syntax highlighting, custom styles, comment system, and more.
- The main menu’s “Docs” entry lists all pages; you can also use tags and search.
- For a complete list of settings, see: Params - Site and Params - Front Matter.