Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/luke2m/watercss-jekyll
A Jekyll theme with water.css styling
https://github.com/luke2m/watercss-jekyll
jekyll-site jekyll-theme water-css
Last synced: about 1 month ago
JSON representation
A Jekyll theme with water.css styling
- Host: GitHub
- URL: https://github.com/luke2m/watercss-jekyll
- Owner: luke2m
- License: mit
- Created: 2021-02-18T22:37:51.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-06-11T19:48:10.000Z (over 3 years ago)
- Last Synced: 2024-03-15T12:12:15.840Z (8 months ago)
- Topics: jekyll-site, jekyll-theme, water-css
- Language: HTML
- Homepage:
- Size: 137 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Water.css Jekyll theme
This is a Jekyll theme with simple styling from [Water.css](https://watercss.kognise.dev) A demo is [here](https://luke2m.github.io/watercss-jekyll/demo.html).
## Installation
### GitHub Pages
Add this line to your `_config.yml`. You can also fork this repo.
```yaml
remote-theme: "luke2m/watercss-jekyll@latest"
```
### Other platforms (Self hosted, Netlify, GitLab Pages, etc.)
Add this line to your Jekyll site's `Gemfile`:
```ruby
gem "water-css"
```
And add this line to your Jekyll site's `_config.yml`:
```yaml
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](https://www.goatcounter.com)
- 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](http://contributor-covenant.org) code of conduct.
## License
The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## TODO
- [x] Customize or disable download and code buttons
- [x] Make easier for non-github users
- [x] Publish Ruby Gem
- [ ] Make version for personal sites/blogs