Skip to content
No description, website, or topics provided.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
_includes
_layouts
_sass
example
.gitignore
CHANGELOG.md
Gemfile
Gemfile.lock
LICENSE.txt
README.md
Rakefile
jekyll-flat.gemspec
screenshot_home.png
screenshot_post.png

README.md

Based on https://github.com/jekyll/minima

Theme not supported on github-pages

jekyll-flat

Live example http://stjhimy.com

Installation

Add this line to your Jekyll site's Gemfile:

gem "jekyll-flat"

And add this line to your Jekyll site:

theme: jekyll-flat

And then execute:

$ bundle

Then add a css/main.scss file based on the following template, don't forget to include the frontmatter:

---
---

@import "flat";

You can choose to override the _includes/head.html file to specify a custom style path.

You can also copy example/index.html to your project in order to have a pixel copy of the page.

Font Awesome Icons

This theme includes all Font Awesome icons as default, making it easier to use any icon:

<i class="fa fa-twitter"></i>
<i class="fa fa-instagram"></i>
<i class="fa fa-github"></i>

Enabling comments (via Disqus)

Optionally, if you have a Disqus account, you can tell Jekyll to use it to show a comments section below each post.

To enable it, add the following lines to your Jekyll site:

  disqus:
    shortname: my_disqus_shortname

You can find out more about Disqus' shortnames here.

Comments are enabled by default and will only appear in production, i.e., JEKYLL_ENV=production

If you don't want to display comments for a particular post you can disable them by adding comments: false to that post's YAML Front Matter.

Enabling Google Analytics

To enable Google Anaytics, add the following lines to your Jekyll site:

  google_analytics: UA-NNNNNNNN-N

Google Analytics will only appear in production, i.e., JEKYLL_ENV=production

Development

To set up your environment to develop this theme, run bundle install.

To test your theme, run bundle exec rake preview and open your browser at http://localhost:4000/flat. This starts a Jekyll server using your theme and the contents of the example/ directory. As you make modifications to your theme and to the example site, your site will regenerate and you should see the changes in the browser after a refresh.

License

The theme is available as open source under the terms of the MIT License.

You can’t perform that action at this time.