Once Jekyll is running, you can start with basic configuration by adding various entries to
_config.yml. Besides these descriptions, you can also read the annotated config file below.
Table of Contents
- GitHub Pages
- Changing accent colors and sidebar images
- Changing fonts
- Using safe web fonts
- Choosing a blog layout
- Using the
bloglayout in a subdirectory
- Using the
- Adding an author
- Adding an author’s picture
- Adding social media icons
- Adding an email, RSS icon or download icon
- Enabling comments
- Enabling Google Analytics
- Changing built-in strings
- Enabling newsletter boxes*
- Annotated config file
The first order of business should be to set the correct
baseurl values in
url is the domain of your site, including the protocol (
https). For this site, it is
# file: _config.yml url: https://qwtel.com
If your entire Jekyll blog is hosted in a subdirectory of your page, provide the path in
baseurl with a leading
/, but no trailing
# file: _config.yml baseurl: /hydejack
Otherwise, provide the empty string
When hosting on GitHub Pages the
https://<username>.github.io (unless you are using a custom domain).
baseurl depends on the kind of page you are hosting.
- When hosting a user or organization page, use the empty string
- When hosting project page, use
For for information on the types of pages you can host on GitHub, see the GitHub Help article.
Changing accent colors and sidebar images
Hydejack allows you to choose the background image of the sidebar, as well as the accent color (color of the links, selection and focus outline, etc…) on a per-page, per-category, per-tag, per-author and global basis.
Set the fallback values in
_config.yml, which are used should no other rule (page, category, tag, author) apply:
# file: _config.yml accent_image: /assets/img/sidebar-bg.jpg accent_color: '#A85641'
accent_image property also accepts the special value
none which will remove the default image.
You can also provide a single color instead of an image like this:
# file: _config.yml accent_image: background: '#202020' # provide a valid CSS background value overlay: false # set to true if you want a dark overlay
Hydejack lets you configure the font of regular text and headlines, and it has built-in support for Google Fonts. There are three keys in
_config.yml associated with this:
google_fonts. The defaults are:
# file: _config.yml font: "'Noto Sans', Helvetica, Arial, sans-serif" font_heading: "'Roboto Slab', Helvetica, Arial, sans-serif" google_fonts: "Roboto+Slab:700|Noto+Sans:400,400i,700,700i"
font_heading must be valid CSS
font-family values. When using Google Fonts make sure they consist of at least two fonts (everything except the first entry will be used as a fallback until the fonts have completed loading).
google_fonts key is the string necessary to fetch the fonts from Google. You can get it from the download page at Google Fonts after you’ve selected one or more fonts:
Using safe web fonts
If you prefer not to use Google Fonts and use safe web fonts instead, set
# file: _config.yml hydejack: no_google_fonts: true
In this case,
font_heading do not have to contain more than one font. You may also remove the
google_fonts key in this case.
Choosing a blog layout
Hydejack features two layouts for showing your blog posts.
listlayout only shows the title and groups the posts by year of publication.
bloglayout is a traditional paginated layout and shows the title and an excerpt of each post.
In order to use the
list layout add the following front-matter to a new markdown file:
--- layout: list title: Home ---
If you want to use the
blog layout, you need to add
jekyll-paginate to your
Gemfile and to the
plugins list in your config file:
# file: Gemfile gem "jekyll-paginate"
# file: _config.yml plugins: - jekyll-paginate
You also need to add the
paginate_path keys to your config file, e.g.
# file: _config.yml paginate: 5 paginate_path: '/page-:num/'
blog layout needs to be applied to a file with the
.html file extension and the
paginate_path needs to match the path to the
index.html file. To match the
paginate_path above, put a
index.html with the following front matter in the root directory:
# file: index.html --- layout: blog title: Blog ---
For more information see Pagination.
blog layout in a subdirectory
If you want to use the blog layout at a URL like
/my-blog/, create the following folder structure:
├── my-blog │ └── index.html ├── my-blog.md └── _config.yml
You can use the same
index.html as before:
# file: my-blog/index.html --- layout: blog title: Blog ---
(Optional) If you want to add a link to the blog in the sidebar, DO NOT add the
menu key to the front matter of
my-blog/index.html. Instead, create a new markdown file called
my-blog.md and add it there:
# file: my-blog.md --- title: Blog menu: true ---
Finally, in your cofnig file, make sue the
pageinate_path matches the location of the index file:
# file: _config.yml paginate: 5 paginate_path: /my-blog/page-:num/
Adding an author
As a bare minimum, you should add an
author key with a
# file: _config.yml author: name: Florian Klampfer email: email@example.com
If you would like the author to be displayed in the about section below a post or project*, as well as the top of about and welcome* pages, add an
about key and provide some markdown content. I recommend using the YAML pipe
| syntax, so you can include multiple paragraphs:
# file: _config.yml author: name: Florian Klampfer email: firstname.lastname@example.org about: | Hi, I'm Florian or @qwtel... This is another paragraph.
Adding an author’s picture
If you’d like for the author’s picture to appear in addition the the about text (see above), you can either use the
jekyll-avatar plugin or provide URLs to images manually.
To use the plugin, add it to your
Gemfile and the list of
plugins in your config file:
# file: Gemfile gem "jekyll-avatar"
# file: _config.yml plugins: - jekyll-avatar
bundle install for the changes to take effect.
Make sure you have provided a GitHub username in your config file (
github_username), or to the author key (
author.github). See Adding social media icons for more.
To set an image manually, you have to provide an URL to the author’s
# file: _config.yml author: picture: /assets/img/me.jpg
If you’d like to provide multiple versions for screens with different pixel densities, you can provide
srcset keys instead:
# file: _config.yml author: picture: path: /assets/img/me.jpg srcset: 1x: /assets/img/me.jpg 2x: /email@example.com
path key is a fallback image for browsers that don’t support the
The keys of the
srcset hash will be used as image descriptors. For more information on
srcset, see the documentation at MDN, or this article from CSS-Tricks.
Adding social media icons
Hydejack supports a variety of social media icons out of the box. These are defined on a per-author basis, so make sure you’ve followed the steps in Adding an author.
You can add a link to a social network by adding an entry to the
social key in to an author. It consists of the name of the social network as key and your username within that network as value, e.g.
# file: _config.yml author: social: twitter: qwtel github: qwtel
authors.yml to see which networks are available. You can also follow the steps here to add your own social media icons.
You can change the order in which the icons appear by moving lines up or down, e.g.
# file: _config.yml author: social: github: qwtel # now github appears first twitter: qwtel
To get an overview of which networks are available and how a typical username in that network looks like, see the included
Should providing a username not produce a correct link for some reason, you can provide a complete URL instead, e.g.
# file: _config.yml author: social: youtube: https://www.youtube.com/channel/UCu0PYX_kVANdmgIZ4bw6_kA
Adding an email, RSS icon or download icon
If you’d like to add an email , RSS , or download icon to the list, add the
download key, e.g.:
# file: _config.yml author: social: email: mailto:firstname.lastname@example.org rss: https://jameschou.info/feed.xml # make sure you provide an absolute URL download: https://github.com/qwtel/hydejack/archive/v7.4.2.zip
Hydejack supports comments via Disqus. Before you can add comments to a page you need to register and add your site to Disqus’ admin console. Once you have obtained your “Disqus shortname”, you include it in your config file:
# file: _config.yml disqus: <disqus shortname>
Now comments can be enabled by adding
comments: true to the front matter.
--- layout: post title: Hello World comments: true ---
You can enable comments for entire classes of pages by using front matter defaults. E.g. to enable comments on all posts, add to your config file:
# file: _config.yml defaults: - scope: type: posts values: comments: true
Enabling Google Analytics
Enabling Google Analytics is as simple as setting the
# file: _config.yml google_analytics: UA-XXXXXXXX-X
Conversely, if you want to disable it, you only have to remove the key and no GA code will be part of the generated pages.
Changing built-in strings
You can change the wording of built-in strings like “Related Posts” or “Read more” in
_data/strings.yml. If you are using the gem-based version, you can get the default file here.
You will frequently find markers like
<!--post_title-->. You can place them freely within your string and they will be replaced with the content they refer to.
You may also use this feature to translate the theme into different languages. In this case you should also set the
lang key to your config file, e.g.
# file: _config.yml lang: cc-ll
cc is the 2-letter country code and
ll specifies a 2-letter location code, e.g.:
You may also change the strings used for formatting dates and times (look out for the
date_formats key), but be aware that the values you provide need to be valid Ruby format directives.
Enabling newsletter boxes*
To enable showing newsletter subscription boxes below each post and project, provide your Tinyletter username to the
tinyletter key in the config file.
# file: _config.yml tinyletter: <tinyletter username>
To edit the content of the newsletter box, open
_data/strings.yml, and change the entries under the
If want to use a different mailing provider, like MailChimp, you can build your own form, and insert it into
_includes/my-newsletter.html. There you will also find an example form for MailChimp, where you need to fill in
site.mailchimp.hidden_input (you can get these from MailChimp).
To build a completely new from, you can use the same CSS classes as Bootstrap. Note that only form, grid and utility classes are available. Check out Forms by Example for some examples.
Annotated config file
Below you find the the complete default
_config.yml file. You may want to copy it when using the gem-based version of the theme.
# Config # ======================================================================================== # IMPORTANT: Set the URL of your page. # Set to https://<username>.github.io when hosting on GitHub Pages # (unless you are using a custom domain). url: https://domain.tld # IMPORTANT: Set The "base URL" of your site. # # When hosting your site in a subdirectory of a server, set to /<name of directory> # (with leading /, but without the < >) # Use the empty string '' otherwise. # # When using GitHub Pages, set to '' when hosting a user- or organization page, # i.e. when the name of the repository looks like <username>.github.io. # Otherwise, set to /<name of repository> (with leading /, but without the < >). baseurl: '' # Language of your content in 2-letter code, e.g.: en, de. # You may also provide a location, e.g.: en-us, de_AT. lang: en # The title of your blog. Used in the sidebar and the browser tab. title: James Chou # A short description (~150 chars) of the page used for the meta description tag. # Can use markdown, but no more than one paragraph (enforced by `>`) description: > Full-stack Developer, Inspired by all things Health IT, and white belt in all martial arts # A shorter description for the sidebar (optional). tagline: > Hire Me # A list of keywords for your blog (optional). keywords:  # Used by jekyll-seo-tag (optional). logo: /assets/icons/icon.png # This should be the same author as first entry in `_data/authors.yml`. # Duplication is necessary due to the `jekyll-feed`, `jekyll-seo-tag` plugin. author: name: <firstname> <lastname> email: <email@example.com> # Used by `jekyll-seo-tag`: # twitter: <username> # This text will appear in a `<small>` tag in the footer of every page. copyright: © 2017. All rights reserved. # Format of the permalinks permalink: pretty # Pagination configuration (used by the `blog` layout) paginate: 5 paginate_path: /page-:num/ # Customizaton # ======================================================================================== # Sidebar image and theme color of the site. accent_image: /assets/img/sidebar-bg.jpg accent_color: '#4fb1ba' # The string encoding which fonts to fetch from Google Fonts. # See: <https://qwtel.com/hydejack/docs/configuration/> google_fonts: Roboto+Slab:700|Noto+Sans:400,400i,700,700i # The text font. Expects a string that is a valid CSS font-family value. font: Noto Sans, Helvetica, Arial, sans-serif # The font used for headings. Expects a string that is a valid CSS font-family value. font_heading: Roboto Slab, Helvetica, Arial, sans-serif # 3rd Party Integrations # ---------------------------------------------------------------------------------------- # Setting a disqus shortname will enable the comment section on # pages with `comments: true` in the front matter. # disqus: <disqus_shortname> # Set your Google Analytics id to receive `pageview` events. # To remove Google Anaylics from your page, remove the line below. # google_analytics: UA-XXXXXXXX-X # Setting a tinyletter username will enable the newsletter subscription box. # PRO version only! # tinyletter: <tinyletter_username> # Hydejack Settings # ---------------------------------------------------------------------------------------- # These settings are specific to Hydejack. hydejack: # Configure the order of complementary content on blog posts post_addons: [about, newsletter, related] # Configure the order of complementary content on project pages project_addons: [about, newsletter, other] # If you do not use Google Fonts, set to `true`. no_google_fonts: false # Set to `true` if you don't want to show an icon indicating external links no_mark_external: false # Set to `true` if third party plugins fail to work with dynamically loaded pages no_push_state: false # Set to `true` if you want to disable the drawer no_drawer: false # Set to `true` if you do not want parts of the css inlined in <head/> # This *may* be benefitial when serving the site over HTTP/2. no_inline_css: false # Code blocks and tables "break" the layout by spanning the full available width. # Set this to true if you want them to be the same width as other content. no_break_layout: false # Set to `true` if you do not want to expose your resume and projects # in machine-readable formats. no_structured_data: false # You can set this to `true` if you don't want to set the `theme-color` meta tag, # This only affects the meta tag, not the color specified in the app manifest. no_theme_color: false # Set to `true` when building with the `--lsi` option use_lsi: false # Collections # ======================================================================================== collections: featured_categories: permalink: /category/:name/ output: true featured_tags: permalink: /tag/:name/ output: true projects: permalink: /projects/:path/ output: true # File inclusion/exclusion # ======================================================================================== exclude: - vendor - Gemfile - Gemfile.lock # Plugins and Plugin Configuration # ======================================================================================== plugins: # - jekyll-avatar # - jekyll-default-layout - jekyll-feed # - jekyll-gist # - jekyll-optional-front-matter - jekyll-paginate # - jekyll-readme-index # - jekyll-redirect-from - jekyll-relative-links # - jekyll-remote-theme - jekyll-seo-tag - jekyll-sitemap # - jekyll-titles-from-headings # Theme # --------------------------------------------------------------------------------------- theme: jekyll-theme-hydejack # remote_theme: qwtel/hydejack@gem # SEO Tag # --------------------------------------------------------------------------------------- # Where you proof that you own this site (used by jekyll-seo-tag) # google_site_verification: <verification-id> # -- or -- # webmaster_verifications: # google: <verification-id> # bing: <verification-id> # alexa: <verification-id> # yandex: <verification-id> # Used for Twitter cards # twitter: # username: <twitter handle> # Used for Facebook open graph # facebook: # app_id: <id> # publisher: <id> # admins: <id> # Used on index and about sites # social: # name: <firstname> <lastname> # links: # - https://twitter.com/<username> # - https://github.com/<username> # Other Plugins # --------------------------------------------------------------------------------------- optional_front_matter: remove_originals: true readme_index: remove_originals: true relative_links: collections: true titles_from_headings: strip_title: true collections: true kramdown: footnote_backlink: '↩︎' math_engine: mathjax math_engine_opts: preview: true preview_as_code: true compress_html: comments: ['<!-- ', ' -->'] clippings: all endings: all sass: style: compressed # If you are upgrading form v5 (or earlier), uncomment the lines below, # so that the location of the feed XML stays the same. # feed: # path: atom.xml
Continue with Basics