mirror of https://github.com/theNewDynamic/gohugo-theme-ananke.git
Ananke is a flexible, production-ready starter theme for Hugo focused on accessibility, performance, and maintainable defaults.
Ananke supports both installation methods:
If you are new to Hugo, see Hugo's official quick start: gohugo.io/getting-started/quick-start.
After installation, use these guides to configure your site:
Find older changelog entries in .github/changelog-old.md
Thanks for helping improve Ananke. This document describes the current contribution workflow for this repository.
i18n/*.tomlThe project follows a structured release workflow based on conventional commits, staging branches, and automated versioning.
For details, see RELEASES.md.
config/_default/module.toml for the current state).bash npm install
npm run instead of just calling hugo server:bash npm run server
This runs the documentation site from site/ using contents from docs/ with local configuration.
Follow the coding style and format commit messages as described in the conventional commits specification (for example: docs: add troubleshooting section or fix: correct hero image path).
Make sure to install git hooks for linting and testing before you push changes:
bash npm run prepare
This command is run automatically after npm install but you can run it manually to set up hooks in an existing clone or update changed hooks. It uses simple-git-hooks to install a commit hook that runs lint-staged for markdown files, which in turn runs linting tasks on staged files.
hugo version, OS, browser if relevant).bash npm run lint:markdown
hugo or hugo server in the relevant project).Fixes #123).To prevent git commit and git push from running hooks you can use the --no-verify flag:
git commit --no-verify -m "docs: update README"
git push --no-verify origin my-feature-branch
This should be used sparingly and only when you have a good reason to bypass checks. If you find yourself needing to use --no-verify frequently, please consider improving the hooks or contributing fixes to reduce false positives.
Documentation lives in multiple places:
README.mdCONTRIBUTING.mddocs/Please keep links relative where possible and remove stale references when updating pages.
If you want to receive attribution for your contribution please follow the contribution guidelines to add yourself to the list of contributors in the Ananke theme documentation. A permanently open issue to add your contribution can be found at the documentation repository. Read the initial message to understand how to add yourself to the list of contributors.
By contributing, you agree that your contributions are provided under the repository license in LICENSE.md.
Copyright (c) 2016-2024 Bud Parr
Copyright (c) 2025-2026 Patrick Kollitsch
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
