This tutorial is a series of tutorials on Jekyll, if you are interested in learning how you can utilize all the features of Jekyll click here for more tutorials.

PART II _



WHAT'S COVERED IN THIS TUTORIAL

WHAT IS JEKYLL?
WHAT IS A YAML.
WHERE TO FIND configure.yml.
HOW TO CONFIGURE JEKYLL.




What is a Yaml?

If you've never heard of a Yaml before it can be pretty confusing as to what you do with it. So let's give you some context so you will have a good foundation to properly impliment your yaml files in the future.


YAML stands for "YAML Ain't Markdown Language" and it is used extensively in Jekyll for its configuration files and also in page settings. YAML is to configuration what markdown is to markdown. It's basically a human-readable structured data format.


So this begs the question; "What is Markdown?"
Markdown is a lightweight markup language with plain text formatting syntax designed so that it can be converted to HTML and many other formats using a tool by the same name.

Find more information here:
Markdown Docs

Keep in mind that if you are going to be serious about using Jekyll for your blog or in general it may be a good idea to visit the link above and familiarize yourself with the syntax. It's honestly not that hard. Maybe a 10 minute look and you've got it.

Where to find configure.yml

config.yml can be found in your main projects folder. Remember in Part I we learned how to make a new Jekyll project and give it a name? Well that same folder houses your config.yml file. This is the file that we will be going over in detail in the next section so ensure you have it open.



How to configure jekyll

When you first open the config.yml file it's filled with some placeholder information. Of course, you'll want to customize this to make your new project your own.


In order to customize the config file, we need to go over what exactly each variable controls

I am calling anything that looks like "ThisIsAVariable:" because jekyll runs Ruby on Rails and this config file actually stores each section as a variable that becomes a standard across all pages of your website or project.

    Config Variables

  • title:

  • This is the name of your website, it will populate automatically across your pages in the header and footer. You can also use Configuring Jekyll to insert it where ever you may wish for it to auto populate.

  • email:
  • Again, this will auto populate on your page where ever you may put the variable ""

  • description:
  • This, is pretty self explanatory, This description by default will be found in your footer, however you may...again... use the variable "" where ever you would like to recycle it.

  • baseurl:
  • This is the subpath to your site, it comes after your main url. just after ".com". Don't use this anywhere else.

  • url:
  • This is...the...ah...url.

  • twitter_username:
  • This is another self explanatory one, basically you input your username, not a link just your username, this variable also calls the footer home and it will automatically link to your twitter account. No mess, no fuss.

  • github_username:
  • This is the same as the twitter variable only for github. Use it the same.

  • markdown:
  • Listen, don't change this one either, this is the markdown superset converter. if you need more information on the specifics of Kramdown (thats the markdown language) and it's syntax click here

Homework

Erase the default information in the variables title:, email:, description:, twitter_username: and github_username: with your own information. Try to see if you can locate all the places on your website it effects. Bonus points if you use one of them as a variable in another part of the page it isn't already setup in.

Share this post: