mirror of https://github.com/theNewDynamic/gohugo-theme-ananke.git

edit | blame | history | raw

Ananke, a starter theme for GoHugo

[!WARNING]
If you are experiencing issues with recent Hugo versions please check the Discussion about the layout changes and add your issues there. Thank you!

The intent of this theme is to provide a solid starting place for GoHugo sites with basic features and include best practices for performance, accessibility, and rapid development.

screenshot

DEMO

Features

  • Responsive
  • Accessible
  • Contact form
  • Custom Robots.txt (changes values based on environment)
  • Internal templates for meta data, google analytics, and DISQUS or COMMENTO comments
  • RSS Discovery
  • Table of Contents (must declare toc: true in post parameter)

Also includes examples of Hugo Features or Functions:

  • Pagination (internal template)
  • Taxonomies
  • Archetypes
  • Custom shortcode
  • Related content
  • Hugo built-in menu
  • i18n
  • with
  • first
  • after
  • sort
  • Site LanguageCode
  • where
  • Content Views
  • Partials
  • Template layouts (type "post" uses a special list template, single template, and a content view)
  • Tags
  • len
  • Conditionals
  • ge (greater than or equal to)
  • .Site.Params.mainSections to avoid hard-coding "blog," etc. [release note]

This theme uses the Tachyons CSS library. This will allow you to manipulate the design of the theme by changing class names in HTML without touching the original CSS files.

Compatibility

[!IMPORTANT]
The main branch contains the latest version of Ananke that is tested and working with GoHugo v0.146.0+. If you wish to use an older version of GoHugo, use the v2.12 branch that is working with GoHugo v0.128.1 to v0.145.0. To get the theme working with an even older version of GoHugo feel free to peruse the releases page to find a version that is working with your GoHugo version.

Installation

Dive into our documentation on installing the theme as GoHugo Module or Git Submodule. The official setup guide of GoHugo covers the installation of the theme as Git Submodule.

Getting started

After installing the theme successfully it requires a few more steps to get your site running. Read on for a quick overview of the most important steps. Or follow one of the more detailed guides following.

Latest Changes

See the CHANGELOG for details about what has changed recently. For a list of older changes, see the changelog-old.md file.

Contributing

If you find a bug feel free to use the issue tracker to let me know. If you are having issues setting up your site with the theme, or have an idea for a feature, please use the discussions for support.

Join me on my ananke-theme Discord channel for direct support, but please remember that I am doing this in my spare time.

If you would like to contribute code, please read the CONTRIBUTING.md file for guidelines on how to contribute.