Cypher - Jekyll Theme
Welcome to the cypher Jekyll theme! This theme is used to power https://cypher.codes.
To install this theme:
gem "cypher-jekyll-theme"to your Gemfile
remote_theme: mikeecb/cypher-jekyll-theme, if you're using Github Pages, to your
bundleor intall the gem yourself by running
gem install cypher-jekyll-theme
To use the theme,
- create a
index.htmlfile that uses the
- override the
_include/contact.htmlfiles to populate the "About" and "Contact" sections on your homepage
- (Optionally) create a
404.htmlfile that uses the
- (Important) add the
jekyll-feedplugin explicitly in your
Bug reports and pull requests are welcome on GitHub at https://github.com/mikeecb/cypher-jekyll-theme. 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
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
_sass tracked with Git will be released.
The theme is available as open source under the terms of the MIT License.