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.

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.
site_author: Carlos Pereira Atencio

# Repository URL used for GitHub links (Edit on GitHub, footer revision link, bottom-left GitHub link).
# GitHub Pages build can auto-detected this value if left unset.
# Set to `false` to disable the GitHub link entirely.
repo_url: 'https://github.com/carlosperate/jekyll-theme-rtd'

# Show/hide the "Edit on GitHub" link in page breadcrumbs.
# GitHub Pages build can auto-detected this value if left unset.
# Default: true
edit_on_github: true

# GitHub branch to use for the "Edit on GitHub" links.
# Default: Automatic detection if built with GitHub Pages, otherwise "main".
github_branch: main

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

# Custom favicon URL.
# If not set, defaults to assets/img/favicon.ico from the theme.
favicon: 'path/to/your_favicon.ico'

# Enables sticky navigation behavior for the left sidebar.
sticky_navigation: true

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

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

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

# List of highlight.js languages to load from cdnjs.
hljs_languages:
  - ruby
  - python
  - javascript
  - bash
  - yaml

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

# Version string to show in the sidebar.
display_version: 1.2.0

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