Repository files navigation

• Get it fromgithub.
• See thelive demo.
• See itin action on my own blog.

A simple and clean Jekyll theme usingbootstrap(not to be confused with jekyll-bootstrap) that's easy to modify and verymodular in component and element reuse.

It uses Disqus for comments and includes Google Analytics support. Both ofthese features are disabled by default and can be enabled via _config.yml. Youcan also rip this code out of the templates if you like (footer.html and post.html).The beauty of Jekyll - keep things clean... Jekyll Clean!

The theme works well on mobile phones, using a collapsable nav bar and hiding thesidebar. The links pane in the sidebar is available on mobile through the nav menu,and you can do the same thing for any other sections added to the sidebar.

Don't forget to occassionally merge against my upstream repository so you can getthe latest changes. Pull requests are encouraged and accepted!

If you don't have a blog already on github, start by cloning this repository.Best to do that directly on github and then clone that down to your computer.

If you already do have a blog, You can certainly apply this theme to your existingblog in place, but then you won't be able to merge as the theme changes. If youre-apply your blog history on top of this theme'sgh-pages branch, it's theneasy to update to the latest version of the theme. You also don't want to have todeal with resolving old conflicts from your existing history, so you may wish to topush your existing master off to a new branch so you have the old history and starta new branch with this as the start, merging in your _posts and other assets (aftergit rm'ing the current _posts.

Not ideal, but you have to make a choice - either apply it manually or base yourblog off this theme's branch. Either way it will work, and both have their ownpros and cons.

You can setup an upstream tracking repository like so:

$ git remote add upstream git@github.com:scotte/jekyll-clean.git

And now when you wish to merge your own branch onto the latest version of thetheme, simply do:

$ git fetch upstream$ git merge upstream/gh-pages

Of course you will have to resolve conflicts for _config.yml, _includes/links-list.html,and _posts, and so on, but in practice this is pretty simple.

This is how I maintain my own blog which is based on this theme. The old history issitting in anold-master branch that I can refer to when I need to.

Here's the exact set of packages I need to install on Debian to run jekylllocally with this theme for testing.

$ sudo aptitude install ruby ruby-dev rubygems nodejs$ sudo gem install jekyll jekyll-paginate

And then it's just a simple matter of running jekyll locally:

$ jekyll serve --baseurl=''

Now browse tohttp://127.0.0.1:4000

Running a jekyll site is a bit outside the scope of this doc, butsometimes it can be a bit confusing how to configure jekyll forproject pages versus user pages, for example.

To start with, read throughthe documentation here.This will provide a good overview on how it all works. The git branch andbaseurl (in _config.yml) will change depending on the sort of site deployed.

When you clone this repository, it's set up for project pages, so thedeployed branch is "gh-pages" and baseurl is configured to 'jekyll-clean',because that's the name of this project.

If you plan to deploy this as user pages, the deployed branch is "master"and baseurl is configured to '' (i.e. empty).

Jekyll clean supports bothisso anddisqus comment systems.

After enablingcomments, eitherisso ordisquss mustbe configured. Don't try configuring both!

Isso requires running a local server, so is not suitable for hostingin github pages, for example. Isso is open source and keeps all yourdata local, unlike Disqus (who knows exactly what they are doing withyour data).

In _config.yml you'll need to setisso to the fully-qualified URLif your isso server (this is the value fordata-isso passed to theisso JS). Make surecomments is true.

Getting Disqus to work can be a bit more work than it seems like it should be.Make sure your Disqus account is correctly configured with the right domainof your blog and you know your Disqus shortname.

In _config.yml you'll need to setdisqus to your Disqus shortname andmake surecomments is true.

Finally, in posts, make sure you havecomments: true in the YAML frontmatter.

More information on using Disqus with Jekyll isdocumented here.

To use code syntax highlighting, use the following syntax:

```pythonimport random# Roll the dieroll = random.randint(1, 20)print('You rolled a %d.' % roll)``` #REMOVE

(Remove #REMOVE from the end of the last line). Which will look like this inthe rendered jekyll output using the default css/syntax.css provided with thistheme (which is thecolorful theme fromhttps://github.com/iwootten/jekyll-syntax):

importrandom# Roll the dieroll=random.randint(1,20)print('You rolled a %d.'%roll)

NOTE: The example in this README.md will render differently than in thefinal jekyll output. See thelive demoto see how it really looks.

You can, of course, use any theme you wish, see the jekyll and pygmentsdocumentation for more details.

The content of this theme is distributed and licensed under aCreative Commons Attribution 4.0 License

This license lets others distribute, remix, tweak, and build upon your work,even commercially, as long as they credit you for the original creation. Thisis the most accommodating of licenses offered. Recommended for maximumdissemination and use of licensed materials.

In other words: you can do anything you want with this theme on any site, just pleaseprovide a link tothe original theme on githubso I get credit for the original design. Beyond that, have at it!

This theme includes the following files which are the properties of theirrespective owners:

• js/bootstrap.min.js -bootstrap
• css/bootstrap.min.css -bootstrap
• js/jquery.min.js -jquery
• images/cc_by_88x31.png -creative commons
• css/colorful.css -iwootten/jekyll-syntax