Skip to aside Skip to content Skip to footer

Configuring the theme

The _config.yml file in the root of your project holds the options and variables used to configure the theme. They are stored as key-value pairs. Apart from title, they are optional and do not have to be included when they are not needed.

General configurations

title: ELIXIR toolkit theme
# This appears in the html browser tab for the site title (seen mostly by search engines, not users)

topnav_title: ELIXIR toolkit theme
# Optional: this appears on the top navigation bar next to the main_logo.svg icon

topnav_banner: "ELIXIR toolkit theme is currently under development and may change at any point - it is not meant for production use"
# Optional: a banner message to display to users on all pages

description: "Flexible Jekyll theme using bootstrap 5 as CSS framework."
# Metadata description of the website

dsw_deep_link_prefix:
# prefix for DSW deep links to a certain question

gtag:
# Google analytics tag

matomo:
# Matomo domain where Matomo is running
matomo_id:
# Integer indicating the Matomo Website ID
matomo_cookies: true
# Boolean that determines whether a Matomo tracking cookie is used or not

plausible:
# Plausible tag
plausible_src:
# default: 'https://plausible.io/js/plausible.js

Additional settings

Certain features are not always needed and can be disabled or changed in your deployment. The example below lists the available options and their default values. Only specify the settings that you want to change.

theme_variables:
  git_host: GitHub
  back_to_top: true
  dev-info-banner: false
  privacy_statement_url: /privacy
  github_buttons:
    position: top
    edit_me: true
    open_issue: true
    history: true
  datatables:
    searchbuilder: false
    pagelength: 10
  headings:
    related-pages: Related pages
    more-information-tiles: More information
    resource-table-all: Tools and resources on this page
    resource-table-all-collapse: false
  page_metadata:
    contributors_sort: true
    coordinators_sort: true
    editors_sort: true
    supported_by_sort: true
  toc:
    min_headings: 1
    headings: 'main h2'
  topnav:
    brand_logo: assets/img/main_logo.svg
    search: true
    github: true
    twitter: false
    bluesky: false
    linkedin: false
    fosstodon: false
  theme_color: 0d6efd
  fonts:
    - url to a font
  breadcrumb: false

More detailed information about these settings can be found here:

  • git_host: This can be GitHub or GitLab and customizes the text in the top navigation.
  • back_to_top: Enables the back to top button.
  • dev-info-banner: Show a development banner including the commit and branch the website is deployed from, when the Jekyll environment is “development”. Default: false
  • privacy_statement_url: Custom path to the privacy page. This is used in the cookie banner.
  • github_buttons: Buttons that link to GitHub actions.
    • position: Can be top, next to the title, or bottom, under the page content.
    • edit_me: Enable the “propose an edit on this page” button.
    • open_issue: Enable the “open an issue on this page” button.
    • history: Enable the “history of this page” button.
  • datatables: Settings related to the DataTables JS library
    • searchbuilder: SearchBuilder provides the end user with an easy to use UI for them to create their own complex custom search expression for a DataTable. Default: false.
    • pagelength: Number of rows to display on a single page. The entries-per-page dropdown uses pagelength multiplied by 2, 5 and 10. Default: 10.
  • headings: Change the subtitles or collapse the page sections that are automatically generated
    • related-pages: Default: Related pages
    • more-information-tiles: Default: More information
    • resource-table-all: Default: Tools and resources on this page
    • resource-table-all-collapse: Make the tools and resources table collapsed like the other more information sections. This will also make the tools and resources table and National resources part of the More information heading. Default: false
  • page_metadata: Configure options related to the page metadata panel at the bottom of the page.
    • contributors_sort: Default: true
    • coordinators_sort: Default: true
    • editors_sort: Default: true
    • supported_by_sort: Default: true
    • affiliations_sort: Deprecated alias for supported_by_sort; it will be removed in ETT v8.0.0.
  • toc: Settings related to the table of contents.
    • min_headings: The minimum number of headings on a page before the table of contents appears. This has to be an integer. Default: 1.
    • headings: The headings indexed by the table of contents. This can be a list or one value, for example h1, h2, h3 or h2. Default: main h2.
  • topnav: Settings related to the top navigation.
    • brand_logo: Custom path to the brand logo, in case assets/img/main_logo.svg cannot be used.
    • search: Enable or disable the search bar. Default: true.
    • github: Enable or disable the GitHub repository navigation link. Default: true.
    • twitter: Add the URL to a Twitter page. Default: false.
    • bluesky: Add the URL to a Bluesky page. Default: false.
    • linkedin: Add the URL to a LinkedIn page. Default: false.
    • fosstodon: Add the URL to a Fosstodon page. Default: false.
  • theme_color: This is the primary theme color which is used in the metadata of the website. Please use the hex color without the hashtag as value.
  • fonts: List URLs to Google Fonts or other custom fonts for your website.
  • breadcrumb: Adds a breadcrumb above the title of every page. The breadcrumb will always represent the URL pattern and works best in combination with permalink style pretty. Default: false