This is a blog template for a static site generator named Jekyll based on a Ghost template named Decent. If you like to see the theme in production have a look at jwillmer.de.
Screenshots
Installation
- To generate/host the blog you need to install Jekyll.
- For the plugins (github-pages) you need to install Bundler:
gem install bundler
- Open a command prompt and install the plugins (github-pages):
bundle install
- On Windows you will propably get an exception. To solve it you can read How to install Jekyll and pages-gem on Windows (x64) or you remove the plugins by deleting the
Gemfile
and delete allgems:
from the_config.yml
- Open a command prompt and install the plugins (github-pages):
Build
- To build the static site you can use the generated site folder that Jekyll creates when you use
jekyll serve
or you can build it explicitly withjekyll build
. - If you like to use GitHub to host your blog you can fork this project and publish the code to
gh-pages
. GitHub has jekyll included and will generate the site for you.
User Content
Blogposts can be written in Markdown.
- The folder for blog content is
_posts
- For author details you need to modify
_data/authors.yml
- For site properties (like the name) you need to modify
_config.yml
androbots.txt
- For the about page you need to modify the
about.md
in_pages
After modifying *.yml
files you need to restart jekyll to take effect.
YAML Features
Following (additional) features are supported in the header (YAML Front Matter) of each post. A detailed description can be found in the YAML Custom Features post.
---
title: Example #Page/post title
author: jwillmer #Page/post author
cover: /image.jpg #Optional: Posibillity to change cover on a post/page
redirect_from: /foo #Optional: Redirect url
visible: false #Optional: Hide page from listing in the menu.
weight: 5 #Optional: Influence sorting of pages in the menu
menutitle: Offline #Optional: Use a secondary name in the menu/post list
tags: hallo welt #Optional: Will be displayed as tags and as keywords in posts
keywords: hallo welt #Optional: Will add keywords to a page
language: en #Optional: Will set a specific language of the page
comments: false #Optional: Will enable/disable comments in your post
---
License
The theme is released under The MIT License (MIT).
The MIT License (MIT)
Copyright (c) 2016 Jens Willmer
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.