jekyll-archie¶ ↑
WARNING: this project is in version 0.0.1, It's not stable yet. It's a starting point for now. Feel free to fork it to help the project
A Jekyll theme based on the Hugo theme Archie by @athul.
Installation¶ ↑
Add this line to your Jekyll site's Gemfile
:
gem "jekyll-archie"
And add this line to your Jekyll site's _config.yml
:
theme: jekyll-archie
And then execute:
$ bundle
Or install it yourself as:
$ gem install jekyll-archie
Usage¶ ↑
I will release a template repository to use with this theme.
Meanwhile you can use the _BLANK_config.yml
as a starting point for your config.
Development¶ ↑
To set up your environment to develop this theme, run bundle install
.
To test your theme, run bundle exec jekyll serve --config _config.yml,_config_dev.yml
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.
Contributing¶ ↑
Bug reports and pull requests are welcome on GitHub at github.com/slashformotion/jekyll-archie. 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 License.