A Jekyll version of the Clean Blog theme by Start Bootstrap, adapted for GitHub Pages by Thanh Tran
CSS JavaScript HTML Other
Switch branches/tags
Nothing to show
Clone or download
Pull request Compare This branch is 44 commits ahead, 60 commits behind BlackrockDigital:gh-pages.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
_includes
_layouts
_posts
css
fonts
img
js
mail
sass
.editorconfig
.gitignore
.scss-lint.yml
Gemfile
Gruntfile.js
LICENSE
README.md
_config.yml
about.html
archive.html
contact.html
index.html
package.json
search.html

README.md

Clean Blog by Start Bootstrap - GitHub Pages version by Thanh Tran

This is a modified version of Clean Blog Jekyll to be fully compatible with GitHub Pages (no pre-compilation needed). Modified by Thanh Tran for his own blog.

The official Jekyll version of the Clean Blog theme by Start Bootstrap.

View Live Demo →

Changes from Original Jekyll Theme

  • Use SASS (SCSS flavor) instead of LESS, with minimal Bootstrap SCSS bundle
  • New choice of typography, remarkably Source Sans Pro for titles and Noto Serif for body texts
  • Support Vietnamese texts
  • Use client-side Prism syntax highlighter (compatible with GitHub-flavored Markdown code fences) instead of pre-rendered Pygments
  • Include Google Analytics script tag. Set your GA ID at site.gaid
  • Include Disqus script to enable commenting. Set your Disqus site's ID at site.disqus_site_id. If not set, the comment section is omitted.
  • Full text search using Google site search. See search.html.
  • A compact posts archive (which list all published blog posts). I believe listing the post titles is better than Search and it generate some sort of information scent.
  • Better image caption using img + em technique. See this example
  • Enable automatic feed generation supported by GitHub Pages, added jekyll-feed in gems in _config.yml file
  • Enable auto sitemap, added jekyll-sitemap in gems in _config.yml file
  • Enable jekyll-seo-tag plugin to generate SEO and social network friendly tags
  • TODO: Implement tags labelling for posts and view by tags
  • TODO: Add modified / update time using front matter or pushed time

Note on the SEO plugin and front matter

  • Use title for both post title and HTML page title
  • Use subtitle for the text below the main title
  • Use description for meta and open graph description
  • Use image for both post header image and open graph image

Before You Begin

In the config.yml file, the base URL is set to /startbootstrap-clean-blog-jekyll which is this themes gh-pages preview. It's recommended that you remove the base URL before working with this theme locally!

It should look like this: baseurl: ""

What's Included

This Jekyll theme is customized to run well on GitHub Pages, therefore it must be built or previewed with github-pages gem to align the plugins and settings. Follow this article for environment installation. After that, you can start previewing the generated site with bundle exec jekyll serve.

A Grunt environment is also included. There are a number of tasks it performs like minification of the JavaScript, compiling of the SCSS files, adding banners to keep the Apache 2.0 license intact, and watching for changes. Run the grunt default task by entering grunt into your command line which will build the files. You can use grunt watch if you are working on the JavaScript or the SCSS.

You can also run grunt serve to watch for changes and test the blog in one command.

Support

This theme is for my own blog which is customized with my own preferences. Issue reports are welcome but I may have little time to respond to questions or installation support.

Besides, please visit Clean Blog's template overview page on Start Bootstrap at http://startbootstrap.com/template-overviews/clean-blog/ for extra info and comments.