The purpose of this Jekyll theme called BasicTheme is to inspire others by providing an overview on creating your very first theme. You can learn more about creating your first theme by visiting my blog post at https://jasong.us/35luIer.

Add this line to your Jekyll site's Gemfile:

gem "BasicTheme"

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

theme: BasicTheme

And then execute:

$ bundle

Or install it yourself as:

$ gem install BasicTheme

In addition, since this is hosted on GitHub, you can use this as a Remote Theme as explained at https://jasong.us/35luIer

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

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

Your theme is setup just like a normal Jekyll 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, _sass and assets tracked with Git will be bundled. To add a custom directory to your theme-gem, please edit the regexp in BasicTheme.gemspec accordingly.

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