Aggregator documentation

This repository contains the source of Aggregator GitHub Pages.

Processing requires Hugo.

The documentation is published at https://tfsaggregator.github.io/.

File&Folders

The documentation is in the content/docs folder. The hugo-book theme generates the left Table of Contents menu navigating the file structure. Put images at the same level as the _index.md file; file with a name different from _index.md should not reference images. If you need images, create a directory with an _index.md file in it. If you want a different name, use the front matter title property, e.g. rule-examples-basic.md use

---
title: 'Basic examples'
weight: 320
---

weight allows change the order of items in the menu.

Markdown content

The right Table of Contents menu, picks only headers level 2 (##) or higher (###, ####, ...) . Do not use Header 1 (single # titles).

Test locally before pushing

Run hugo serve.