Theme Configuration

This theme is configured via your Jekyll or GitHub Pages’ _config.yml file. Below are the standard Jekyll options and the theme-specific settings you can use to customise the look and behaviour of your site.

Generic _config.yml configuration

These are standard Jekyll configuration options that the theme uses:

title: This is the title for your site
description: And this is a short description that goes with it.

# If building with Jekyll this sets the URL for your site, useful to be able to
# include it in the metadata for social media cards and SEO.
# GitHub pages builds automatically detects this, so you can leave it unset.
url: 'https://yourdomain.com'

Theme Specific Configuration

The following options are specific to this theme and can be added to your _config.yml to control features like the sidebar logo, navigation, search, analytics, and more:

# Name shown in the footer copyright and in the page author meta tag.
# Default: Unset
site_author: Carlos Pereira Atencio

# Language for the site, used in the html lang attribute.
# Should be a single BCP 47 language tag.
# Default: en
lang: en

# Locale for Open Graph tags. Accepts both hyphen and underscore formats
# (e.g. en_US or en-US, fr_FR or fr-FR).
# Default: en_US
locale: en_US

# Repository URL used for GitHub links (like Edit on GitHub,
# footer revision link, bottom-left GitHub link).
# Default Jekyll: Unset, so the links will not appear.
# Default GH Pages: Auto-detected, so links will appear if unset.
# Set to `false` to disable the GitHub links entirely.
repo_url: 'https://github.com/carlosperate/jekyll-theme-rtd'

# Show/hide the "Edit on GitHub" link in page breadcrumbs.
# Default Jekyll: Unset, so the link will not appear.
# Default GH Pages: Auto-detected, so the link will appear if unset.
# Set to `false` to disable the "Edit on GitHub" link specifically.
edit_on_github: true

# GitHub branch to use for the "Edit on GitHub" links.
# Default Jekyll: "main"
# Default GH Pages: Auto-detected, so the default branch will be used.
github_branch: main

# Logo image URL shown at the top of the left sidebar.
# If not set, the site title is shown instead.
# Default: Unset
logo: 'path/to/your_image.png'

# Custom favicon URL.
# Default: assets/img/favicon.ico from the theme if it exist, otherwise unset.
favicon: 'path/to/your_favicon.ico'

# Enables sticky navigation behaviour for the left sidebar.
# Default: false
sticky_navigation: true

# List of external links to show at the bottom of the sidebar navigation.
# Each entry is either a link or a section header.
# Section headers group the links that follow them.
# Default: Unset
nav_external_links:
  - title: A link without a section header
    url: 'https://example.com'
  - section: Links
  - title: A link under the Links section
    url: 'https://example.com'
  - title: Another link under the Links section
    url: 'https://example.com'
  - section: More Links
  - title: A link under the More Links section
    url: 'https://example.com'

# Where to show previous/next navigation buttons.
# Options: none, top, bottom, both
# Default: none
prev_next_buttons_location: both

# Enables the search box in the sidebar.
# Default: true
search_enabled: true

# highlight.js style name loaded from cdnjs.
# Default: github
hljs_style: github

# List of highlight.js languages to load from cdnjs.
# Default: Empty, so no additional languages loaded.
hljs_languages:
  - ruby
  - python
  - javascript
  - bash
  - yaml

# Enables admonitions (GitHub-style blockquote callouts like [!NOTE], [!WARNING], etc).
# Default: true
admonitions: true

# Enables Mermaid diagram rendering.
# JS file is around 850 KB Gzip, disable it if you'd like to save the bandwidth.
# Default: true
mermaid: true

# Version string to show in the sidebar.
# Default: Unset
display_version: 1.4.0

# Social media card image shown when the site is shared on social platforms
# (Twitter/X, LinkedIn, Discord, Slack, etc.). Recommended size: 1200×630px.
# Used as the default for all pages; individual pages can override it via
# the `social_image` front matter field.
# Default: site logo if set, otherwise no image (text-only card).
social_image: 'path/to/your_social_card.jpg'

# Alt text for the social card image above.
# Default: site title
social_image_alt: 'A description of the social card image'

# Twitter/X handle for the site (without the @).
# Used in the twitter:site meta tag.
# Default: Unset
twitter: yourtwitterhandle

# Mastodon/Fediverse handle for the site, in the full @user@instance format.
# Used in the fediverse:creator meta tag for Mastodon profile link verification.
# Default: Unset
fediverse: '@you@mastodon.social'

# List of additional CSS & JS files to load for all pages, path relative to the site base URL.
# Default: Empty, so no additional files loaded.
extra_javascript:
  - assets/js/my_custom_file.js
extra_css:
  - assets/css/my_custom_file.css