Water.css Jekyll theme (Work in Progress)¶ ↑
This is a Jekyll theme for GitHub Pages with simple styling from Water.css
Installation¶ ↑
Add this line to your _config.yml
(only on GitHub Pages). You can also fork or download this repo and host it wherever you want. A Ruby Gem will be published once this is more complete.
remote-theme: "luke2m/watercss-jekyll@main"
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 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¶ ↑
-
[x] Customize or disable download and code buttons
-
[ ] Make easier for non-github users
-
[ ] Publish Ruby Gem
-
[ ] Make version for personal sites/blogs