This page lists the parameters that Ananke v2.23.0 reads from your site configuration and from page front matter. Each table gives the type, the default value, the places where you can set the option, and the page that explains its use. To learn where configuration files go and how Hugo combines them with the theme defaults, read How Ananke configuration works.
Use the Set in column to find where a value has an effect:
- Site: the
params table of your site configuration. A front matter value has no effect. - Site, page: the site value is the default; a page value in front matter, also through
cascade, replaces it for that page. Use the same key path in front matter without the params prefix. - Page: front matter only. The front matter reference lists more page-only keys.
A default of “none” means that the theme ships no value and the feature stays off or uses the behaviour that the table describes.
General options
#
These options are under [params.ananke].
copy_code- Type
- Boolean
- Default
true- Set in
- Site
Shows a copy button on code blocks. Set false to remove it.
custom_css- Type
- List of strings
- Default
- None
- Set in
- Site
Stylesheets in
assets/, or partials that return CSS, added after the theme styles. See
Custom CSS.
responsive_image_widths- Type
- List of integers
- Default
[480, 960, 1440, 1920]- Set in
- Site, page
Widths in pixels for featured image variants. See
Images.
section_link- Type
- String
- Default
- None: the section page
- Set in
- Site, page
Destination of the section label above an article title:
first, or the path of a page in the section. See
hook catalogue.
show_categories- Type
- Boolean
- Default
true- Set in
- Site
show_recent_posts- Type
- Boolean
- Default
true- Set in
- Site
Shows recent posts below the homepage introduction. See
Homepage.
Homepage
#
params.ananke.home.content_alignment- Type
- String
- Default
"center"- Set in
- Site
Alignment of the homepage introduction on large screens:
left,
center, or
right. See
Homepage.
params.recent_posts_number- Type
- Integer
- Default
3- Set in
- Site, homepage
Number of recent post cards. The homepage also links up to four more posts. See
Homepage.
params.mainSections- Type
- List of strings
- Default
- Hugo’s main sections
- Set in
- Site
Sections that supply recent posts. Hugo uses the section with the most pages when you do not set a value. See
Homepage.
Dates, section titles, and list cards
#
Site values for these options are under [params.ananke.pages]. Page values for the show_* options are directly under ananke in front matter, for example ananke.show_single_date. The precedence rules explain how Ananke selects a value.
show_date- Type
- Boolean
- Default
- None: show
- Set in
- Site, page
Shared fallback for show_single_date and show_summary_date.
show_single_date- Type
- Boolean
- Default
- None: show
- Set in
- Site, page
Date on a single page.
show_summary_date- Type
- Boolean
- Default
- None: show
- Set in
- Site, page
Date on summary cards, including recent posts on the homepage.
show_section_title- Type
- Boolean
- Default
- None: show
- Set in
- Site, page
Section title above the post title on compact list cards.
show_list_images- Type
- Boolean
- Default
- None: no images
- Set in
- Site, list page
Uses image cards on list pages. The front matter key is
ananke.pages.show_list_images in the list page’s
_index.md. See
General configuration.
Other date settings:
params.date_format- Type
- String
- Default
"January 2, 2006"- Set in
- Site
Header and navigation
#
These options are under [params.ananke.header] and [params.ananke.navigation]. See Header layout and hooks and Menus.
header.navigation- Type
- List of groups
- Default
[["logo"], ["languages", "menu", "social"]]- Set in
- Site, page
Groups of components in the navigation bar. A group is a list of component names or one name. Give the complete layout: your list replaces the default.
header.content- Type
- List of strings
- Default
["title", "description"]- Set in
- Site, page
Components below the navigation bar, from top to bottom.
navigation.submenu_mode- Type
- String
- Default
"split"- Set in
- Site, page
Desktop submenu behaviour: split, hover, click, or toplevel.
navigation.classes.<element>- Type
- String
- Default
- Empty: theme classes
- Set in
- Site, page
Replaces the Tachyons classes of one navigation element.
The <element> keys and the theme classes that an empty value uses:
Colours, typefaces, and header images
#
These options are directly under [params], not under [params.ananke]. Each value is a list of Tachyons classes, separated by spaces. See Colours and typefaces and Page headers.
background_color_class- Type
- String
- Default
"bg-black"- Set in
- Site
Background of the header without an image, the footer, and submenus.
body_classes- Type
- String
- Default
"avenir bg-near-white"- Set in
- Site, page
Classes on the body element.
text_color- Type
- String
- Default
"mid-gray"- Set in
- Site, page
Text colour of the main content and of cards.
post_content_classes- Type
- String
- Default
"serif"- Set in
- Site, page
Classes on the content of a single page.
header_section_class- Type
- String
- Default
- Depends on the header
- Set in
- Site, page
Classes on the title area of the header. The theme uses tc-l pv4 pv6-l ph3 ph4-ns on list pages and the homepage with an image, tc-l pv3 ph3 ph4-ns on those pages without an image, and tc-l pv6 ph3 ph4-ns on single pages with an image.
featured_image_class- Type
- String
- Default
"cover bg-top"- Set in
- Site
Classes on the header with an image on list pages and the homepage.
featured_image_class- Type
- String
- Default
"cover bg-center"- Set in
- Page
Classes on the header with an image on a single page. The site value does not apply to single pages.
cover_dimming_class- Type
- String
- Default
"bg-black-60"- Set in
- Site
Overlay on the header image on list pages and the homepage.
cover_dimming_class- Type
- String
- Default
"bg-black-60"- Set in
- Page
Overlay on the header image on a single page. The site value does not apply to single pages.
Site identity
#
These options are directly under [params].
site_logo- Type
- String
- Default
- None: the site title
- Set in
- Site
favicon- Type
- String
- Default
- None
- Set in
- Site
Path of the favicon file, relative to the site root.
description- Type
- String
- Default
- None
- Set in
- Site
Meta description of the homepage, list pages, and taxonomy pages without their own description. Single pages use their summary instead. See
SEO.
author- Type
- String
- Default
- None
- Set in
- Site, page
Summaries and reading time
#
These options are directly under [params]. See Summaries and reading time.
read_more_copy- Type
- String
- Default
- Translated “Read more” text
- Set in
- Site, page
Text of the link on summary cards.
show_reading_time- Type
- Boolean
- Default
- None: hidden
- Set in
- Site, section, page
Shows reading time and word count on single pages when the value is true. A top-level section’s _index.md can also enable it for its pages.
reading_speed- Type
- Integer
- Default
- None: Hugo’s estimate
- Set in
- Site
Words per minute for the reading time.
Social links
#
These options are under [params.ananke.social]. See Social media networks for complete examples, and the social network reference for the built-in networks and the keys of a network definition.
follow.networks- Type
- List of strings
- Default
- None: no follow links
- Set in
- Site
Network slugs for follow links in the header and footer.
share.networks- Type
- List of strings
- Default
- None: no share links
- Set in
- Site
Network slugs for share links on single pages.
share.icons- Type
- Boolean
- Default
true- Set in
- Site
Shows an icon in each share link. When false, the link shows its text instead.
share.sharetext- Type
- Boolean
- Default
true- Set in
- Site
Gives each share link the text “Share on” and the network label. Links with icons use it as their title and accessible name. If you set both icons and sharetext to false, the links are empty.
<network>.username- Type
- String
- Default
- None
- Set in
- Site
Your user name. Ananke inserts it into the network’s profile address.
<network>.profilelink- Type
- String
- Default
- None
- Set in
- Site
A complete profile address. Replaces the address made from username.
<network>.label- Type
- String
- Default
- The network label
- Set in
- Site
Network name in the title and accessible name of your follow link.
<network>.rel- Type
- String
- Default
- None
- Set in
- Site
Value added to the link’s rel attribute, for example me.
networks.<network>- Type
- Table
- Default
- 24 networks
- Set in
- Site
Share links on a page are hidden when its front matter contains disable_share. In v2.23.0, this includes disable_share: false.
Some shipped values have no effect in v2.23.0:
share.disable_share in the site configuration does not hide share links.follow.new_window_icon and icon_path are in the theme defaults, but no template reads them.
Shortcodes
#
These options are under [params.ananke.shortcodes].
edit_page.repo_url- Type
- String
- Default
- None: no link, with a build warning
- Set in
- Site
Address of the GitHub repository. See
Edit page.
edit_page.branch- Type
- String
- Default
"main"- Set in
- Site
Branch for the edit link.
edit_page.content_dir- Type
- String
- Default
"content"- Set in
- Site
Content directory in the repository.
edit_page.target- Type
- String or
false - Default
"_blank"- Set in
- Site
Link target. false opens the link in the same window.
since.repo_url- Type
- String
- Default
- None: a badge without a link
- Set in
- Site
Format string for the release link.
%s receives the version. See
Since.
since.target- Type
- String or
false - Default
"_blank"- Set in
- Site
Link target. false opens the link in the same window.
Hooks
#
These options are under [params.ananke.hooks]. See Hooks and filters.
verbosity- Type
- String
- Default
"error"- Set in
- Site
Hook messages in the build log: debug, info, warning, or error.
disable_messages- Type
- List of strings
- Default
- None
- Set in
- Site
Message groups to suppress. unused_hooks hides the notice about hooks without a partial.
These options are directly under [params]. See Comments.
commentoEnable- Type
- Boolean
- Default
- None: off
- Set in
- Site
Adds Commento comments to single pages.
commentoPath- Type
- String
- Default
"https://cdn.commento.io/js/commento.js"- Set in
- Site
Address of the Commento script.
Hugo settings that Ananke uses
#
Ananke also reads some of Hugo’s own settings. Hugo’s documentation describes them.
Deprecated options
#
Back to contents