Drop - Jekyll theme

A vertical scrolling template for Jekyll, with a falling drop theme.

You can preview the theme here

Drop Theme

Installation

Add this line to your Jekyll site's Gemfile:

gem "jekyll-theme-drop"

And add this line to your Jekyll site's _config.yml:

theme: jekyll-theme-drop

And then execute:

$ bundle

Or install it yourself as:

$ gem install jekyll-theme-drop

Usage

For those unfamiliar with how Jekyll works, check out jekyllrb.com for all the details, or read up on just the basics of front matter, writing posts, and creating pages.

Configuration

You can use the following custom parameters in _config.yml.

Site

  • subtitle sets the text for the lighter colored text next to your site's title.

Social

  • 500px_url
  • facebook_url
  • github_url
  • gitlab_url
  • googleplus_url
  • instagram_url
  • linkedin_url
  • pinterest_url
  • slack_url
  • twitter_url

Contact

  • street_address
  • city
  • state
  • zip_code
  • country
  • phone
  • email

Publication

To post your website as a Github page, fork this reposity and create a branch named gh-pages, then start editing the _config.yml file.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/moodule/jekyll-theme-drop. 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.

To test the theme, run bundle exec jekyll serve and open your browser at http://localhost:4000. This starts a Jekyll server using the theme. Add pages, documents, data, etc. like normal to test the theme's contents. As you make modifications to the 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 the theme is released, only the files in _layouts, _includes, _sass and assets tracked with Git will be bundled. To add a custom directory to the theme-gem, please edit the regexp in jekyll-theme-drop.gemspec accordingly.

 Credits

Inspired by the work of @ajlkn.

Repository Jekyll logo icon licensed under a Creative Commons Attribution 4.0 International License.

License

The theme is available as open source under the terms of the CC-BY-4.0.