helixml / docs

Hugo Static Site Generator

This outline provides an overview of the Hugo Static Site Generator used for this website.

Templating

Hugo uses a templating language based on Go’s text/template package. Templates are written in .html files and use special syntax to define variables, loops, and conditional logic.

Layouts

Layouts are the top-level templates that define the structure of the entire website. The layouts directory contains all the layout files.

  • baseof.html: This layout defines the basic structure of the website, including the header, footer, and main content area.
  • index.html: This layout defines the structure of the homepage.
  • single.html: This layout defines the structure of individual posts and pages.

Partials

Partials are reusable snippets of HTML code that can be included in other templates. The layouts/partials directory contains all the partial files.

  • header.html: This partial defines the header content, including the site title and navigation links.
  • footer.html: This partial defines the footer content, including copyright information.
  • social.html: This partial defines the social media links.

Shortcodes

Shortcodes are custom functions that provide a convenient way to insert complex content into templates. The layouts/shortcodes directory contains all the shortcode files.

  • gallery.html: This shortcode generates a photo gallery.
  • video.html: This shortcode embeds a video player.
  • quote.html: This shortcode displays a quote.

Content Organization

Content files are organized into folders, based on their type and category. Each content file contains front matter, which provides metadata about the content.

  • content/posts: This folder contains blog posts.
  • content/pages: This folder contains static pages.

Front Matter

Front matter is a section of YAML or TOML data at the top of each content file. It provides information about the content, such as its title, date, author, and categories.

---
          title: "My Blog Post"
          date: 2023-01-01T00:00:00Z
          author: "John Doe"
          categories: ["Blog"]
          ---

Hugo Modules and Extensions

Hugo provides a rich ecosystem of modules and extensions that can extend its functionality.

  • Hugo-Paper: This module provides a clean and minimal theme.
  • Hugo-Academic: This module provides a theme specifically designed for academic websites.
  • Hugo-Netlify-CMS: This module integrates Netlify CMS with Hugo.
  • Hugo-Shortcodes: This module provides a set of built-in shortcodes.

This outline provides a basic understanding of how the Hugo Static Site Generator is used to build the website. You can find more information about Hugo and its features on the official Hugo website.