Skip to content

Instantly share code, notes, and snippets.

@nicolashery

nicolashery/environment-variables-jekyll-templates.md

Last active January 22, 2023 15:56
Show Gist options
  • Save nicolashery/5756478 to your computer and use it in GitHub Desktop.
Save nicolashery/5756478 to your computer and use it in GitHub Desktop.
Download ZIP
Make environment variables available in Jekyll Liquid templates
Raw
environment-variables-jekyll-templates.md

Environment variables in Jekyll templates

This is one way to pass some data (API tokens, etc.) to your Jekyll templates without putting it in your _config.yml file (which is likely to be committed in your GitHub repository).

Copy the environment_variables.rb plugin to your _plugins folder, and add any environment variable you wish to have available on the site.config object.

In a Liquid template, that information will be available through the site object. For example, _layouts/default.html could contain:

<head>
   <!-- ... -->
  {% if site.env == 'production' %}
    <link rel="stylesheet" href="/build/style.min.css">
  {% else %}
    <link rel="stylesheet" href="/style.css">
  {% endif %}
</head>

Running jekyll build will use style.css by default. If you set export JEKYLL_ENV=production before running jekyll build, it will use style.min.css.

Raw
environment_variables.rb
# Plugin to add environment variables to the `site` object in Liquid templates
module Jekyll
class EnvironmentVariablesGenerator < Generator
def generate(site)
site.config['env'] = ENV['JEKYLL_ENV'] || 'development'
# Add other environment variables to `site.config` here...
end
end
end
@jveillet
Copy link

jveillet commented Jan 24, 2017 •
edited
Loading

I was just searching to do that, very helpfull thanks! 👍
As someone else poited out, I required the dotenv gem and it works wonders.

@mosinski
Copy link

mosinski commented May 6, 2017

@k-funk nice tip thx 👍

@ScottA38
Copy link

ScottA38 commented Mar 25, 2021

This plugin is not needed since there exists JEKYLL_ENV
http://www.csinaction.com/2015/02/07/environments-in-jekyll-aka-jekyll_env/
@duleorlovic @errordeveloper

Your answers are very old so sorry for the question - how exactly does Jekyll.environment allow you to add custom ENV variables in _config?

@leogzyl
Copy link

leogzyl commented Jan 22, 2023

Really helpful, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment