- Fork the repo
- Remove sample posts from
_postsfolder and add yours.
- Change repo name to
A quick checklist of the files you’ll want to edit to get up and running.
Site Wide Configuration
_config.yml is your friend. Open it up and personalize it. Most variables are self explanatory but here’s an explanation of each if needed:
The title of your site… shocker!
title: My Awesome Site
The description to show on your homepage.
The description to use for meta tags and navigation menu.
Set true to show reading time for posts. And set
words_per_minute, default is 200.
Your site’s logo. It will show on homepage and navigation menu. Also used for twitter meta tags.
Image for background. If you don’t set it, color will be used as a background.
It’s enabled. But if you don’t want to use it. Set it false in
Set your disqus shortname in
_config.yml to use comments.
To set what links appear in the top navigation edit
_data/navigation.yml. Use the following format to set the URL and title for as many links as you’d like. External links will open in a new window.
Layouts and Content
This theme uses Jekyll Compress to compress html output. But it can cause errors if you use “linenos” (line numbers). I suggest don’t use line numbers for codes, because it won’t look good with this theme, also i didn’t give a proper style for them. If you insist to use line numbers, just remove
layout: compress string from layouts. It will disable compressing.
You can set feature image per post. Just add
feature: some link to your post’s front matter.
feature: /assets/img/some-image.png or feaure: http://example.com/some-image.png
This also will be used for twitter card:
To show disqus comments for your post add
comments: true to your post’s front matter.
Found a bug or aren’t quite sure how something works? By all means file a GitHub Issue. And if you make something cool with this theme feel free to let me know.
This theme is free and open source software, distributed under the MIT License. So feel free to use this Jekyll theme on your site without linking back to me or including a disclaimer.