Skip to content

Latest commit

 

History

History
57 lines (40 loc) · 1.68 KB

README.md

File metadata and controls

57 lines (40 loc) · 1.68 KB
Raw

Water.css Jekyll theme

This is a Jekyll theme with simple styling from Water.css A demo is here.

Installation

GitHub Pages

Add this line to your _config.yml. You can also fork this repo.

remote-theme: "luke2m/watercss-jekyll@latest"

Other platforms (Self hosted, Netlify, GitLab Pages, etc.)

Add this line to your Jekyll site's Gemfile:

gem "water-css"

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

theme: water-css

And then execute:

$ bundle

Or install it yourself as:

$ gem install water-css

Usage

This theme is meant for quick repo docs, not blogs or personal sites. I may make a theme for that purpose sometime soon. Configurable variables (in _config.yml):

  • Light, Dark, or Automatic theme
  • Title and description
  • Show or hide download and source links
  • Change View on GitHub to another name
  • Change download link
  • Add privacy friendly analytics with GoatCounter
  • More customization will be coming soon.

Contributing

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

TODO

  • Customize or disable download and code buttons
  • Make easier for non-github users
  • Publish Ruby Gem
  • Make version for personal sites/blogs