mirror of https://github.com/theNewDynamic/gohugo-theme-ananke.git
[!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.
Features
toc: true in post parameter)Also includes examples of Hugo Features or Functions:
withfirstaftersortwherelenge (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.
[!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.
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.
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.
See the CHANGELOG for details about what has changed recently. For a list of older changes, see the changelog-old.md file.
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.
Find older changelog entries in .github/changelog-old.md
Thank you for your interest in improving the Ananke Hugo theme! Contributions of all kinds help keep the theme useful for the community. This document explains how to get started, what kinds of contributions we welcome, and how to collaborate effectively.
We welcome many forms of help, including:
i18n/ directory.hugo version matches the version in config/_default/hugo.toml > min_version.npm install.hugo server and open the served URL.hugo version), OS, browser).fix/menu-alignment).layouts/, assets/, and static/ (this will be updated with a link to coding standards as soon as we have them).npm test for JavaScript-related checks.hugo server and hugo to verify the site builds without errors.README.md, config/, or relevant component docs to reflect your changes.Please review and follow the principles in the project's Code of Conduct (to be implemented). If you see behavior that violates these guidelines, report it through the project issue tracker or contact a maintainer privately.
By contributing, you agree that your contributions will be licensed under the same terms as the project, as detailed in LICENSE.md.
Copyright (c) 2016-2024 Bud Parr
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.
