water-css 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4901bedeee0ce50e298d26ce1757aee75331a02279f71cd21fbbc5157f5200cf
+  data.tar.gz: abaa6be19f291b73752499f27f6b1c881922e9f5bdfb62c80f063137408fe118
+SHA512:
+  metadata.gz: 196833b82591c483fc6050a14cbff3b9c8d2cc9770a4079a3636be47f1c2300b4a2ca506b10c154954cbcd5189b0eaba067c093b039afdcdbee2e359e5086202
+  data.tar.gz: 0f7dfc45842954d46d2c574b365392527311ba758bf82a18c93f8e025638fa7d4a10ef75df24a65bf488df55fa26aff586b04f10ca47ba53ea075085c93d6a0b

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Luke Metoki
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,36 @@
+# Water.css Jekyll theme (Work in Progress)
+
+This is a Jekyll theme for GitHub Pages with simple styling from [Water.css](https://watercss.kognise.dev)
+## 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.
+
+```yaml
+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](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
+- [ ] Make easier for non-github users
+- [ ] Publish Ruby Gem
+- [ ] Make version for personal sites/blogs
+

data/README.md.bak

@@ -0,0 +1,47 @@
+# Water.css Jekyll theme
+
+This is a Jekyll theme for GitHub Pages with simple styling from [Water.css](https://watercss.kognise.dev)
+# Once this theme is finished and published, the below will apply.
+## Installation
+
+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
+
+TODO: Write usage instructions here. Describe your available layouts, includes, sass and/or assets.
+
+## 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.
+
+## 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 `water-css.gemspec` accordingly.
+
+## License
+
+The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+

data/_config.yml

@@ -0,0 +1,20 @@
+# Title for your page
+title: Put Your Title Here
+
+# Description for your page
+description: "A Great Project has a lot of description needed"
+
+# Theme -- dark light or auto
+css: auto
+
+# Show downloads links -- True or false 
+show_downloads: true
+
+# Not using GitHub? Change this.
+git_provider: GitHub
+
+#Different Download link?
+#download_url: "https://example.com"
+
+#Goatcounter Tracking Code
+#goatcounter: myproject

data/_includes/head.html

@@ -0,0 +1,20 @@
+<head>
+	<!-- Responsive and required -->
+	<meta charset="UTF-8">
+	<meta name="viewport" content="width=device-width,initial-scale=1">
+	<!-- Styling -->{% if site.css == dark %}
+	<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/water.css@latest/out/dark.min.css"> {% elsif site.css == light %}
+	<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/water.css@latest/out/light.min.css"> {% else %}
+	<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/water.css@latest/out/water.min.css"> {% endif %}
+	<meta name="viewport" content="width=device-width, initial-scale=1">
+	<!-- Primary Meta Tags -->
+	<title>{{ page.title | default: site.title | default: site.github.repository_name }}</title>
+	<meta name="title" content="{{ page.title | default: site.title | default: site.github.repository_name }}">
+	<meta name="description" content="{{ page.description | default: site.description | default: site.github.project_tagline }}">
+	<!-- Open Graph / Facebook -->
+	<meta property="og:title" content="{{ page.title | default: site.title | default: site.github.repository_name }}">
+	<meta property="og:description" content="{{ page.description | default: site.description | default: site.github.project_tagline }}">
+	<!-- Twitter -->
+	<meta property="twitter:title" content="{{ page.title | default: site.title | default: site.github.repository_name }}">
+	<meta property="twitter:description" content="{{ page.description | default: site.description | default: site.github.project_tagline }}"> 
+  </head>

data/_layouts/default.html

@@ -0,0 +1,21 @@
+<!DOCTYPE html>
+<html lang="{{ site.lang | default: " en-US " }}">
+{% include head.html %}
+<body>
+	<h1 style="text-align: center;">{{ page.title | default: site.title | default: site.github.repository_name }}</h1>
+	<h2 style="text-align: center;">{{ page.description | default: site.description | default: site.github.project_tagline }}</h2>
+	{% if site.show_downloads %}
+	<h3 style="text-align: center;"><a href="{{ site.repo_url | default: site.github.repository_url }}">View on {{ site.git_provider | default: GitHub }}</a>&nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;<a href="{{ site.download_url | default: site.github.repository_url }}/releases">Downloads</a></h3>
+	{% endif %}
+	<hr>
+	{{ content }}
+	<footer class="site-footer">
+		{% if site.github.is_project_page %}
+		<span><a href="{{ site.github.repository_url }}">{{ site.github.repository_name }}</a> is maintained by <a href="{{ site.github.owner_url }}">{{ site.github.owner_name }}</a>.</span>
+		{% endif %}
+		<br> <span>This page was generated by <a href="https://pages.github.com">GitHub Pages</a> using the <a href="https://github.com/luke2m/watercss-jekyll">water.css theme</a>.</span> 
+	
+	</footer> {% if site.goatcounter %}
+	<script data-goatcounter="https://{{ site.goatcounter }}.goatcounter.com/count" async src="//gc.zgo.at/count.js"></script> {% endif %} </body>
+
+</html>

data/assets/css/auto.css

@@ -0,0 +1 @@
+@import https://cdn.jsdelivr.net/npm/water.css@latest/out/water.min.css;

data/assets/css/dark.css

@@ -0,0 +1 @@
+@import https://cdn.jsdelivr.net/npm/water.css@latest/out/dark.min.css;

data/assets/css/light.css

@@ -0,0 +1 @@
+@import https://cdn.jsdelivr.net/npm/water.css@latest/out/light.min.css

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: water-css
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Luke Metoki
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-02-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description:
+email:
+- hello@lukesempire.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- README.md.bak
+- _config.yml
+- _includes/head.html
+- _layouts/default.html
+- assets/css/auto.css
+- assets/css/dark.css
+- assets/css/light.css
+homepage: https://github.com/luke2m/watercss-jekyll/
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.7
+signing_key:
+specification_version: 4
+summary: A simple Jekyll theme for GitHub Pages, using Water.css styling
+test_files: []