gemdev

A minimalist Jekyll theme for developers.

Installation

Follow the steps in this Jekyll Guide if you're beginning with Jekyll from scratch.

  1. Create a new Jekyll project

    jekyll new newProject

  2. Build the site and make it available on a local server

    bundle exec jekyll serve --watch

  3. Add this line to your Jekyll site's Gemfile:

    gem "gemdev"

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

    theme: gemdev

  5. And then execute:

    $ bundle

  6. Or install it yourself as:

    $ gem install gemdev

  7. To update the theme run:

    $ bundle update

    Usage

In _config.yml you can specify:

  • header_name: provide the title in header
  • url: specify the site url
  • social: list your socials
  • project: list your projects providing a name, url and description

Contributing

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

License

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