geekyll

This theme has been created with one thing in mind: Displaying a summary of all site content in the landing page. Have you ever seen those landing pages (WordPress, usually) where “all” page layouts are displayed in the home page and accessible via scrolling? That's the idea.

What's included

Before you go

Installation

Add this line to your Jekyll site's Gemfile:

gem "geekyll"

Plus, add this another one to your _config.yml or to the :jekyll_plugins variable within your Gemfile. It is for processing Liquid tags manually.

gem "liquefy", "~> 0.1.2"

And add this line to your Jekyll site:

theme: geekyll

And then execute:

$ bundle

Or install it yourself as:

$ gem install geekyll

Usage

Front-page system

There are only two steps to follow in order to set up the front-page system:

Other layouts:

Includes

### _config.yml

This theme can be customized through:

social_links:
  - platform: twitter
    url: //twitter.com/
    icon: fa fa-twitter
    title: Check my Twitter profile
  - platform: github
    url: //github.com/
    icon: fa fa-github
    title: Check my Github repos
  - platform: gitlab
    url: //gitlab.com/
    icon: fa fa-gitlab
    title: Check my gitlab repos
footer:
  copyright: Copyright © 2014-2016 ...
  featuring: Site made with A. Hosting by B.
  socials:
    github: katodia
    twitter: katodians
    email: info@katodia.com
    googleplus: +Katodia-Desarrollo-Aplicaciones
extra_js:
  - assets/js/contact-form.js
  - assets/js/anchor-animation.js
meta: 
  keywords: web, development, game, design
  foo: bar

Output:

<meta name"keywords" content="web, development, game, design" />
<meta name"foo" content="bar" />

Contributing

Bug reports and pull requests are welcome on GitHub at github.com/sonirico/geekyll/issues. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

Development

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

You theme is setup just like a normal Jelyll site! To test your theme, run bundle exec jekyll serve and open your browser at http://localhost:4000. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.

When your theme is released, only the files in _layouts, _includes, and _sass tracked with Git will be released.

License

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