no-style-please 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 360b8b480989db056edf39d88abb2351d9a7dceeadb69c0fb7d7009eb05a142c
-  data.tar.gz: ae3ce04c8c17b35f8aa038ee65db879e0f7d1783da12640870f4f6f0f526a7f4
+  metadata.gz: 1400532adf56860c17470b48995337de44d71760120df748d1e2f496c4e0a522
+  data.tar.gz: 79d7a895706ebc44aba4e43a956fe3b9e938bd0169a408218aa725539e2b4e66
 SHA512:
-  metadata.gz: 63770655480e98cea80eefa481e6e29c509a57cbd819d1e20a19d17b7104823dcf1d0468a822e8f9d4036d1f42f76381cc654dd56fa6154385e2e9ccb9e026bb
-  data.tar.gz: 8817fa1e7dc0f2dfa465decfaae650a4e35f0f31f64ec27c50a90d8d6b8f68f18ca6f8ca24a47bb4242148df4f7bac35b95a6cd53c6a5869a082192416a71aab
+  metadata.gz: fbbfaa09b602c9a8e6df2f777f7bfa701be7327a0c16e4d1ef26a74a23bb87ba18ed9df8d3bed7075c2dc8d0714bbc67f565a842955b796fc7014cdbeba77da5
+  data.tar.gz: 76a05f75b254776fb7900577164fdcea38141bab9393ffd4ba99c478747794810309e4bdc77b4fdae02046885ccc829b0505b2379bb2c2bff2fef350553fbf06

data/README.md

@@ -1,15 +1,16 @@
 # no style, please!
 
-<img src="./logo.png" width="64" align="left" />A (nearly) no-CSS, fast, minimalist [Jekyll](https://jekyllrb.com/) theme.
+<img src="https://raw.githubusercontent.com/riggraz/no-style-please/master/logo.png" width="64" align="left" />A (nearly) no-CSS, fast, minimalist [Jekyll](https://jekyllrb.com/) theme.
 Inspired by [elly's site](http://tilde.town/~elly/), expressly created for [my personal blog](https://riggraz.dev/).
 
 <h3 align="center"><a href="https://riggraz.dev/no-style-please/">Try the demo out!</a></h3>
 
-<img src="./_screenshots/featured-image.png" />
+<img src="https://raw.githubusercontent.com/riggraz/no-style-please/master/_screenshots/featured-image.png" />
 
 ## Features
 
-* Fast (**< 1kb of CSS**, see [Page Speed Insights report](https://raw.githubusercontent.com/riggraz/no-style-please/master/_screenshots/page-speed-insights-report.png) and [Lighthouse report](https://raw.githubusercontent.com/riggraz/no-style-please/master/_screenshots/lighthouse-report.png))
+* Fast (**< 1kb of CSS**, currently 955 bytes. For more information on performance and more, see [Page Speed Insights report](https://raw.githubusercontent.com/riggraz/no-style-please/master/_screenshots/page-speed-insights-report.png) and [Lighthouse report](https://raw.githubusercontent.com/riggraz/no-style-please/master/_screenshots/lighthouse-report.png))
+* Light, dark and auto modes
 * Responsive
 * Content first (typography optimized for maximum readability)
 * SEO optimized (uses [Jekyll SEO Tag](https://github.com/jekyll/jekyll-seo-tag))
@@ -48,7 +49,7 @@ If you want to use this theme for your Jekyll's site deployed on [GitHub Pages](
 
 ## Usage
 
-You can edit `_config.yml` file to customize your blog. You can change things such as the name of the blog, the author, how dates are formatted, etc. Customizable fields should be straightforward to understand, however `_config.yml` contains some comments to help you understand what each fields does.
+You can edit `_config.yml` file to customize your blog. You can change things such as the name of the blog, the author, the appearance of the theme (light, dark or auto), how dates are formatted, etc. Customizable fields should be straightforward to understand. Still, `_config.yml` contains some comments to help you understand what each field does.
 
 For further customization (e.g. layout, CSS) see the [official Jekyll's documentation](https://jekyllrb.com/docs/themes/#overriding-theme-defaults) on customizing gem-based themes.
 
@@ -66,9 +67,19 @@ The `menu.yml` file accepts the following fields:
     - `post_list`, which can be `true` or `false`. If it is true, the entry will have all posts in the site as subentries. This is used to render your post list.
     - `entries`, yes, you can have entries inside entries. In this way you can create nested sublists!
 
+### Pro tips
+
+#### Dark mode for images
+
+This theme provides dark mode by inverting all colors of light mode throught the CSS `invert()` function. This approach would also invert the color of all images, but, since this is not the behaviour one would expect, images are not inverted by default.
+
+However, if you would like to force the color inversion on a specific image you can do so by applying `class="ioda"` to that image ("ioda" stands for "invert on dark appearance"). See the image in the [overview post](https://github.com/riggraz/no-style-please/blob/master/_posts/2020-07-07-overview-post.md) for an example of this approach. Note that color inversion will take place only when the theme has dark appearance!
+
+For example, if you have a black and white image it could make sense to invert it in dark mode. On the other hand, a colorful image will probably look bad if inverted.
+
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hello. 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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/riggraz/no-style-please. 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
 

data/_config.yml

@@ -13,6 +13,7 @@ favicon: "./logo.png" # relative path to site's favicon
 theme: no-style-please # if you are using GitHub Pages, change it to remote_theme: riggraz/no-style-please
 
 theme_config:
+  appearance: "auto" # can be "light", "dark" or "auto"
   back_home_text: ".." # customize text for homepage link in post layout
   date_format: "%Y-%m-%d" # customize how date is formatted
   show_description: false # show blog description in home page

data/_layouts/default.html

@@ -1,5 +1,5 @@
 <!DOCTYPE html>
-<html lang="{{ page.lang | default: "en" }}">
+<html lang="{{ page.lang | default: "en" }}" a="{{ site.theme_config.appearance | default: "auto" }}">
         {%- include head.html -%}
     <body>
     <main class="page-content" aria-label="Content">

data/_sass/no-style-please.scss

@@ -1,10 +1,24 @@
+@mixin dark-appearance {
+  filter: invert(1);
+  img {
+    filter: invert(1);
+
+    &.ioda { filter: invert(0); }
+  }
+}
+
+html[a="dark"] { @include dark-appearance; }
+
+@media (prefers-color-scheme: dark) {
+  html[a="auto"] { @include dark-appearance; }
+}
+
 html {
   color: black;
   background-color: white;
   font-family: monospace;
   font-size: 1.3rem;
   line-height: 1.3;
-  -webkit-font-smoothing: antialiased;
 }
 
 h2, h3, h4, h5, h6 { margin-top: 3rem; }
@@ -55,4 +69,10 @@ blockquote {
   padding: 1rem;
 
   p { margin: 0; }
+}
+
+img {
+  max-width: 100%;
+  display: block;
+  margin: 0 auto;
 }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: no-style-please
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Riccardo Graziosi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-23 00:00:00.000000000 Z
+date: 2020-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -90,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A (nearly) no-CSS, fast, minimalist Jekyll theme.