rzen/jekyll-theme-isabelline
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
Simple clean mobile-friendly theme for long form blogging. Also good for private note taking.
4 Commits 1 Branch 0 Tags 14 MiB
CSS 58.7%
HTML 22.8%
JavaScript 14.2%
Ruby 2.4%
Shell 1.2%
Other 0.7%
cfea7a9010
Go to file
rzen cfea7a9010 Delete '.DS_Store'
2019-07-22 04:32:01 +00:00
_blog wip 2019-07-21 23:33:03 -04:00
_includes wip 2019-07-21 23:33:03 -04:00
_layouts init 2019-07-21 22:16:23 -04:00
_pages wip 2019-07-21 23:33:03 -04:00
_sass init 2019-07-21 22:16:23 -04:00
assets wip 2019-07-21 23:33:03 -04:00
_config.yaml wip 2019-07-21 23:33:03 -04:00
.gitignore wip 2019-07-22 00:12:19 -04:00
404.html wip 2019-07-21 23:33:03 -04:00
CHANGELOG.md wip 2019-07-21 23:33:03 -04:00
docker-compose-user.yaml wip 2019-07-21 23:33:03 -04:00
docker-compose.yaml wip 2019-07-22 00:12:19 -04:00
Gemfile wip 2019-07-21 23:33:03 -04:00
index.html init 2019-07-21 22:16:23 -04:00
jekyll-theme-isabelline.gemspec wip 2019-07-22 00:12:19 -04:00
LICENSE.txt init 2019-07-21 22:16:23 -04:00
private.html init 2019-07-21 22:16:23 -04:00
README.md wip 2019-07-21 23:33:03 -04:00

README.md

jekyll-theme-isabelline

Welcome to your new Jekyll theme! In this directory, you'll find the files you need to be able to package up your theme into a gem. Put your layouts in _layouts, your includes in _includes, your sass files in _sass and any other assets in assets.

To experiment with this code, add some sample content and run bundle exec jekyll serve – this directory is setup just like a Jekyll site!

TODO: Delete this and the text above, and describe your gem

Installation

Add this line to your Jekyll site's Gemfile:

gem "jekyll-theme-isabelline"

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

theme: jekyll-theme-isabelline

And then execute:

$ bundle

Or install it yourself as:

$ gem install jekyll-theme-isabelline

Usage

This theme supports pages, posts and blogs. Unlike posts, blogs can be setup to not show the date of the post in the article's URL.

Theme can be configured by tweaking _sass/_config.scss. To do so you need to first copy it from github and place in _sass/_config.scss.

All colors are derived from $hue. You can tweak individual colors to your liking further down the config file.

Contributing

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

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 jekyll-theme-isabelline.gemspec accordingly.

License

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