- Add your own content
- Last important thing: YAML front matter ("parameters" for a page)
- Features
- Advanced: local development
- Credits and contributions
To add a post to the main page, simple create a file in the _posts
directory. The newly created file must be of the form: yyyy-mm-dd-<title>.md
. This file will then be transformed into HTML by jekyll when you commit it to the repo
In order to have your new pages use this template and not just be plain pages, you need to add YAML front matter to the top of each page. This is where you'll give each page some parameters that I made available, such as a title and subtitle. I'll go into more detail about what parameters are available later. If you don't want to use any parameters on your new page (this also means having no title), then use the empty YAML front matter:
---
---
If you want to use any parameters, write them between the two lines. For example, you can have this at the top of a page:
---
title: Contact me
subtitle: Here you'll find all the ways to get in touch with me
---
You can look at the top of aboutme.md
or index.html
as more examples.
Important takeaway: ALWAYS add the YAML front matter, which is two lines with three dashes, to EVERY page. If you have any parameters, they go between the two lines. If you don't include YAML then your file will not use the template.
Beautiful Jekyll is designed to look great on both large-screen and small-screen (mobile) devices. Load up your site on your phone or your gigantic iMac, and the site will work well on both, though it will look slightly different.
Many personalization settings in _config.yml
, such as setting your name and site's description, setting your avatar to add a little image in the navigation bar, customizing the links in the menus, customizing what social media links to show in the footer, etc.
If you want to enable comments on your site, Beautiful Jekyll supports the Disqus comments plugin. To use it, simply sign up to Disqus and add your Disqus shortname to the disqus
parameter in the _config.yml
.
If the disqus
parameter is set in the configuration file, then all blog posts will have comments turned on by default. To turn off comments on a particular blog post, add comments: false
to the YAML front matter. If you want to add comments on the bottom of a non-blog page, add comments: true
to the YAML front matter.
Beautiful Jekyll lets you easily add Google Analytics to all your pages. This will let you track all sorts of information about visits to your website, such as how many times each page is viewed and where (geographically) your users come from. To add Google Analytics, simply sign up to Google Analytics to obtain your Google Tracking ID, and add this tracking ID to the google_analytics
parameter in _config.yml
.
By default, all blog posts will have buttons at the bottom of the post to allow people to share the current page on Twitter/Facebook/LinkedIn. You can choose to enable/disable specific social media websites in the _config.yml
file. You can also turn off the social media buttons on specific blog posts using social-share: false
in the YAML front matter.
Beautiful Jekyll automatically generates a simple RSS feed of your blog posts, to allow others to subscribe to your posts. If you want to add a link to your RSS feed in the footer of every page, find the rss: false
line in _config.yml
and change it to rss: true
.
- post - To write a blog post, add a markdown or HTML file in the
_posts
folder. As long as you give it YAML front matter (the two lines of three dashes), it will automatically be rendered like a blog post. Look at the existing blog post files to see examples of how to use YAML parameters in blog posts. - page - Any page outside the
_posts
folder that uses YAML front matter will have a very similar style to blog posts. - minimal - If you want to create a page with minimal styling (ie. without the bulky navigation bar and footer), assign
layout: minimal
to the YAML front matter. - If you want to completely bypass the template engine and just write your own HTML page, simply omit the YAML front matter. Only do this if you know how to write HTML!
These are the main parameters you can place inside a page's YAML front matter that Beautiful Jekyll supports.
Parameter | Description |
---|---|
title | Page or blog post title |
subtitle | Short description of page or blog post that goes under the title |
bigimg | Include a large full-width image at the top of the page. You can either give the path to a single image, or provide a list of images to cycle through (see my personal website as an example). |
comments | If you want do add Disqus comments to a specific page, use comments: true . Comments are automatically enabled on blog posts; to turn comments off for a specific post, use comments: false . Comments only work if you set your Disqus id in the _config.yml file. |
show-avatar | If you have an avatar configured in the _config.yml but you want to turn it off on a specific page, use show-avatar: false . If you want to turn it off by default, locate the line show-avatar: true in the file _config.yml and change the true to false ; then you can selectively turn it on in specific pages using show-avatar: true . |
image | If you want to add a personalized image to your blog post that will show up next to the post's excerpt and on the post itself, use image: /path/to/img . |
share-img | If you want to specify an image to use when sharing the page on Facebook or Twitter, then provide the image's full URL here. |
social-share | If you don't want to show buttons to share a blog post on social media, use social-share: false (this feature is turned on by default). |
use-site-title | If you want to use the site title rather than page title as HTML document title (ie. browser tab title), use use-site-title: true . When set, the document title will take the format Site Title - Site Description (eg. My website - A virtual proof that name is awesome! ). By default, it will use Page Title if it exists, or Site Title otherwise. |
layout | What type of page this is (default is blog for blog posts and page for other pages. You can use minimal if you don't want a header and footer) |
js | List of local JavaScript files to include in the page (eg. /js/mypage.js ) |
ext-js | List of external JavaScript files to include in the page (eg. //cdnjs.cloudflare.com/ajax/libs/underscore.js/1.8.2/underscore-min.js ). External JavaScript files that support Subresource Integrity (SRI) can be specified using the href and sri parameters eg.href: "//code.jquery.com/jquery-3.1.1.min.js" sri: "sha256-hVVnYaiADRTO2PzUGmuLJr8BLUSjGIZsDYGmIJLv2b8=" |
css | List of local CSS files to include in the page |
ext-css | List of external CSS files to include in the page. External CSS files using SRI (see ext-js parameter) are also supported. |
googlefonts | List of Google fonts to include in the page (eg. ["Monoton", "Lobster"] ) |
This template was not made entirely from scratch. I would like to give special thanks to:
- Barry Clark and his project Jekyll Now, from whom I've taken several ideas and code snippets, as well as some documenation tips.
- Iron Summit Media and their project Bootstrap Clean Blog, from which I've used some design ideas and some of the templating code for posts and pagination.
I'd also like to thank Dr. Jekyll's Themes, Jekyll Themes, and another Jekyll Themes for featuring Beautiful Jekyll in their Jekyll theme directories.