Cleaner Blog Jekyll

This is a fork of the StartBootstrap Clean Blog Jekyll theme.

That repo was very old, hadn't been updated in a long time, and didn't have all the features we would have liked, so we decided to fork it.

Cleaner Blog is a stylish, responsive blog theme for Bootstrap. This theme features a blog homepage, about page, contact page, and an example post page.

Preview

Installation & Setup

Using RubyGems

When installing the theme using RubyGems, demo images, posts, and pages are not included. Follow the instructions below for complete setup.

1. (Optional) Create a new Jekyll site: jekyll new my-site

2. Replace the current theme in your Gemfile with:

   gem 'jekyll-theme-cleaner-blog', git: 'https://github.com/btc-raspberrypiclub/cleaner-blog-jekyll'
   

3. Install the theme by running bundle install inside your site directory.

4. Replace the current theme in your _config.yml file with theme: jekyll-theme-cleaner-blog.

5. Add the following variable to your _config.yml:

   navigation:
   - name: Home
     link: /
   - name: About
     link: /about/
   - name: Posts
     link: /posts/
   - name: Contact
     link: /contact/

   This describes the navbar at the top of your site. If it is not present, there will be no links on your navbar. You can add or remove links here to customize your navigation.

6. Build your site: bundle exec jekyll serve

Assuming there are no errors and the site is building properly, follow these steps next:

1. Create the following pages if they do not exist already (or change the extension of existing markdown files from .md to .html):

   • index.html - set to layout: home
   • about.html - set to layout: page
   • contact.html - set to layout: page
   • posts/index.html - set to layout: page (you will also need to create a posts directory)

2. Configure the index.html front matter. Example:

   ---
   layout: home
   background: '/PATH_TO_IMAGE'
   ---

3. Configure the about.html, contact.html, and posts/index.html front matter. Example:

   ---
   layout: page
   title: Page Title
   description: This is the page description.
   background: '/PATH_TO_IMAGE'
   ---

4. For each post in the _posts directory, update the front matter. Example:

   ---
   layout: post
   title: "Post Title"
   subtitle: "This is the post subtitle."
   date: YYYY-MM-DD HH:MM:SS
   background: '/PATH_TO_IMAGE'
   ---

   For reference, look at the demo repository to see how the files are set up.

5. Create 404.html if it doesn't already exist, and modify the front matter.

   ---
   layout: page
   title: 404
   description: Page not found
   permalink: /404.html
   ---

6. Build your site: bundle exec jekyll serve

Using Core Files

When using the core files, the demo images, posts, and pages are all included with the download. After following the instructions below, you can then go and change the content of the pages and posts.

1. Download or Clone the repository.

2. Update the following configuration settings in your _config.yml file:

   • baseurl
   • url
   • title
   • email
   • description
   • author
   • twitter_username (Optional)
   • facebook_username (Optional)
   • github_username (Optional)
   • linkedin_username (Optional)
   • instagram_username (Optional)

3. Build your site: bundle exec jekyll serve

Bugs and Issues

Have a bug or an issue with this template? Open a new issue here on GitHub!

About

The "Cleaner Blog" theme was forked from a theme created by StartBootstrap. You can learn more about them here.

Copyright and License

Code released under the MIT license.