no-style-please 0.1.6 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4931613fa693afd5baae6754d3def6fd25a050a8d32dff2af2677733c7cea89
-  data.tar.gz: 84e3124bb32ba0c8b40b3cc6a9f1daa74d92619bf23ec1e29d89ea3612ac797e
+  metadata.gz: 442f43ae145f3cf3f4e0b9f9e8ef851a7b82f08bd339168c0e0b98825e49f732
+  data.tar.gz: 30e7d6afaea0f459f9942db138035c045d9eee83d44dcf029eed7250c414af67
 SHA512:
-  metadata.gz: fabf42e3b09173948965662902c70c1992dab8a54a655da8628c3985d26c4c04442d3c73695ee2e69c6f08ba97bbb7e978c17bc0116457449c038b527161725f
-  data.tar.gz: 11842ec0ad987981435b3da948a25ab05bf007f4f9362daf597b9d69c4479a67abea9b573f9845821b9130b762d48af9050e24a2e084418685423db5e5f5044c
+  metadata.gz: f575b2d5608c6cc903f6d9b025130430f2bc643712614ddfd12c86bc94b0eb2d5d2cfbe73cb88dd3ff27ab81fa84a84d18779c358510bcf6d263ac1f320db9c7
+  data.tar.gz: 8ab21365b756381780641d1621a1cb56a85058108147d6cc59e132121237187e2cfe7a8ee7d4aff582fd6dee551f6fe8779b44ba409cb04bf0ef929b70c7a19c

data/README.md

@@ -1,10 +1,21 @@
 # no style, please!
 
-<img src="./logo.png" width="64" align="left" /> A (nearly) no-css minimalist [Jekyll](https://jekyllrb.com/) theme. Inspired by [elly's site](http://tilde.town/~elly/), expressly created for [my personal blog](https://riggraz.dev/).
+<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/).
 
-[Try the demo out!](https://riggraz.dev/no-style-please/)
+<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!** 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))
+* RSS feed (uses [Jekyll Feed](https://github.com/jekyll/jekyll-feed))
+* Fully compatible with [GitHub Pages](https://pages.github.com/) (see [GitHub Pages installation](#github-pages-installation))
 
 ## Installation
 
@@ -38,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.
 
@@ -50,15 +61,52 @@ The `menu.yml` file accepts the following fields:
 
 - `entries` define a new unordered list that will contain menu entries
 - each entry is marked by a `-` at the beginning of the line
-- each entry has the following attributes:
-    - `title`, which defines the text to render for that menu entry
-    - `url`, which can either be a URL or `false`. If it is `false`, the entry will be rendered as plain text; otherwise the entry will be rendered as a link pointing to the specified URL. Note that the URL can either be relative or absolute.
-    - `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.
+- each entry can have the following attributes:
+    - `title`, which defines the text to render for this menu entry (**NB: you can also specify HTML!**)
+    - `url`, which can be used to specify an URL for this entry. If not specified, `title` will be rendered as-is; otherwise `title` will be sorrounded by a link tag pointing to the specified URL. Note that the URL can either be relative or absolute. Also note that you can get the same result by placing an ```<a>``` tag in the `title` field.
+    - `post_list`, which can be set either to `true` or to an object. If it is true, the entry will have a list of all posts as subentries. This is used to render your post list. If you want to customize which posts to render (e.g. by category), you can add one or more of the following attributes under `post_list`:
+        - `category`, which can be set to a string. It is used to render a list of posts of the specified category only. If you don't set it, then posts of all categories will be rendered.
+        - `limit`, which can be set to a number. It specifies the number of posts to show. If not set, all posts will be rendered.
+        - `show_more`, which can be true. If it is true and if the number of posts to show is greater than the specified `limit`, render a link to another page. To specify the URL and the text of the link, you can set `show_more_url` and `show_more_text` attributes, which are documented below.
+        - `show_more_url`, which can be a string. It specifies the URL for the show more link. Use only if `show_more` is true. This will usually redirect to a page containing all posts, which you can easily create using an archive page (see [create archive pages](#create-archive-pages) section)
+        - `show_more_text`, which can be a string. It specifies the text for the show more link. Use only if `show_more` is true.
     - `entries`, yes, you can have entries inside entries. In this way you can create nested sublists!
 
+### Create archive pages
+
+A so-called archive page is a page that shows a list of posts (see [this](https://riggraz.dev/no-style-please/all-posts) for an example). You can create an archive page by creating a page and putting the following frontmatter:
+
+```
+---
+layout: archive
+title: The title of the page here
+which_category: name-of-category
+---
+```
+
+`which_category` is optional: if you don't put it, then all posts of the blog will be listed; on the other hand, if you specify a category, only posts of that category will be shown.
+
+This feature is particularly useful if used together with the `show_more` attribute in the menu. For example, if you want to limit the number of posts shown in the home page to 5 but add a link to view them all, then you can create an archive page using the method showed above and link to it using the `show_more_url` attribute in `menu.yml`. See [this example](https://github.com/riggraz/no-style-please/blob/master/_data/menu.yml) if you're in doubt.
+
+### Customize the index page
+
+The `index.md` page should use layout `home`, which is the layout that displays the menu. If you want to have some content after the menu, you can just add that content in the `index.md` file, and it will automatically show under the menu.
+
+Another thing you can do to customize the index page is show the description of your blog between the title and the menu. To do this, just edit `_config.yml` and change `theme_config.show_description` to `true`.
+
+### 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

@@ -1,16 +1,20 @@
 title: no style, please! # name of the site
 author: Riccardo Graziosi # name of site's author
 email: riccardo.graziosi97@gmail.com # email of site's author
-url: https://riggraz.dev/no-style-please # root address of the site
+url: https://riggraz.dev # root address of the site
+baseurl: "/no-style-please" # subpath of the site, e.g. "/blog" (leave it blank "" if you're site shouldn't use a subpath)
 description: > # description of the site (multiple lines allowed)
-  A (nearly) no-css minimalist Jekyll theme.
+  A (nearly) no-CSS, fast, minimalist Jekyll theme.
 
-favicon: "./logo.png" # relative path to site's favicon
+permalink: /:slug.html
+
+favicon: "logo.png" # name+extension of favicon (which must be put on the root folder)
 # goat_counter: "yoursitename" # put your GoatCounter name if you want to use GoatCounter analytics
 
 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/_includes/back_link.html

@@ -0,0 +1 @@
+<a href="{{ "/" | relative_url }}">{{ site.theme_config.back_home_text }}</a>

data/_includes/head.html

@@ -4,16 +4,16 @@
   <meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <title>
-    {% if page.title %}
+    {%- if page.title -%}
       {{ page.title }}
-    {% else %}
+    {%- else -%}
       {{ site.title }}
-    {% endif %}
+    {%- endif -%}
   </title>
 
   {% seo title=false %}
   {% feed_meta %}
 
-  <link rel="shortcut icon" type="image/x-icon" href="/{{ site.favicon }}" />
-  <link rel="stylesheet" href="{{ site.url }}/assets/css/main.css" />
+  <link rel="shortcut icon" type="image/x-icon" href="{{ site.favicon | relative_url }}" />
+  <link rel="stylesheet" href="{{ "/assets/css/main.css" | relative_url }}" />
 </head>

data/_includes/menu_item.html

@@ -1,18 +1,25 @@
 <ul>
   {% for item in include.collection %}
     <li>
-    {% if item.url != false %}
+    {%- if item.url -%}
       <a href="{{ item.url }}">{{ item.title }}</a>
-    {% else %}
+    {%- else -%}
       {{ item.title }}
-    {% endif %}
+    {%- endif -%}
     </li>
 
-    {% if item.post_list == true %}
-      {% include post_list.html %}
+    {% if item.post_list %}
+      {%
+        include post_list.html
+          category=item.post_list.category
+          limit=item.post_list.limit
+          show_more=item.post_list.show_more
+          show_more_text=item.post_list.show_more_text
+          show_more_url=item.post_list.show_more_url
+      %}
     {% endif %}
 
-    {% if item.entries != blank %}        
+    {% if item.entries %}
       {% include menu_item.html collection=item.entries %}
     {% endif %}
   {% endfor %}

data/_includes/post_list.html

@@ -1,9 +1,25 @@
-{% if site.posts.size > 0 %}
+{% if include.category %}
+  {% assign posts = site.categories[include.category] %}  
+{% else %}
+  {% assign posts = site.posts %}
+{% endif %}
+
+{% if include.limit and posts.size > include.limit %}
+  {% assign limit_exceeded = true %}
+{% else %}
+  {% assign limit_exceeded = false %}
+{% endif %}
+
+{%- if posts.size > 0 -%}
   <ul>
-    {% for post in site.posts %}
-      <li>
-        {{ post.date | date: site.theme_config.date_format }} <a href="{{ post.url | relative_url }}">{{ post.title | downcase }}</a>
-      </li>
-    {% endfor %}
+    {%- for post in posts limit: include.limit -%}
+        <li>
+          <span>{{- post.date | date: site.theme_config.date_format -}}</span>
+          <a href="{{ post.url | relative_url }}">{{ post.title | downcase }}</a>
+        </li>
+    {%- endfor -%}
+    {%- if include.show_more and limit_exceeded -%}
+      <li><a href="{{ include.show_more_url }}">{{ include.show_more_text | default: "Show more..." }}</a></li>
+    {%- endif -%}
   </ul>
-{% endif %}
+{%- endif -%}

data/_layouts/archive.html

@@ -0,0 +1,9 @@
+---
+layout: default
+---
+
+{% include back_link.html %}
+
+<h1>{{ page.title }}</h1>
+
+{% include post_list.html category=page.which_category %}

data/_layouts/default.html

@@ -1,15 +1,15 @@
 <!DOCTYPE html>
 <html lang="{{ page.lang | default: "en" }}">
-        {%- include head.html -%}
-    <body>
+  {%- include head.html -%}
+  <body a="{{ site.theme_config.appearance | default: "auto" }}">
     <main class="page-content" aria-label="Content">
-        <div class="wrapper">
-            {{ content }}
-        </div>
+      <div class="w">
+        {{ content }}
+      </div>
     </main>
 
     {% if site.goat_counter and jekyll.environment == "production" %}
-        {% include goat_counter.html %}
+      {% include goat_counter.html %}
     {% endif %}
-    </body>
+  </body>
 </html>

data/_layouts/home.html

@@ -3,9 +3,11 @@ layout: default
 ---
 <header>
   <h1>{{ site.title }}</h1>
-  {% if site.theme_config.show_description == true %}
+  {% if site.theme_config.show_description %}
     <p>{{ site.description }}</p>
   {% endif %}
 </header>
 
-{% include menu_item.html collection=site.data.menu.entries %}
+{% include menu_item.html collection=site.data.menu.entries %}
+
+{{ content }}

data/_layouts/page.html

@@ -0,0 +1,9 @@
+---
+layout: default
+---
+
+{% include back_link.html %}
+
+<h1>{{ page.title }}</h1>
+
+{{ content }}

data/_layouts/post.html

@@ -2,15 +2,14 @@
 layout: default
 ---
 
-<a href="{{ site.url }}">{{ site.theme_config.back_home_text }}</a>
-<h1>{{ page.title }}</h1>
-{{ content }}
+{% include back_link.html %}
 
-<hr data-content="keep in touch">
-<form style="padding:3px;text-align:center;" action="https://tinyletter.com/riggraz" method="post" target="popupwindow" onsubmit="window.open('https://tinyletter.com/riggraz', 'popupwindow', 'scrollbars=yes,width=800,height=600');return true">
-  <label for="tlemail">Your email address:</label>
-  <input type="text" style="width:140px" name="email" id="tlemail" />
-  <input type="hidden" value="1" name="embed"/>
-  <input type="submit" value="Subscribe" />
-  <p>No spam</p>
-</form>
+<article>
+  <p class="post-meta">
+    <time datetime="{{ page.date }}">{{ page.date | date: site.theme_config.date_format }}</time>
+  </p>
+  
+  <h1>{{ page.title }}</h1>
+
+  {{ content }}
+</article>

data/_sass/no-style-please.scss

@@ -1,12 +1,39 @@
-html {
+// -------------- THEME SWITCHER -------------- //
+@mixin dark-appearance {
+  filter: invert(1);
+  img {
+    filter: invert(1);
+
+    &.ioda { filter: invert(0); }
+  }
+}
+
+body[a="dark"] { @include dark-appearance; }
+
+
+@media (prefers-color-scheme: dark) {
+  body[a="auto"] { @include dark-appearance; }
+}
+// -------------------------------------------- //
+
+// bg color is also needed in html in order to
+// block body's background propagation
+// see: https://stackoverflow.com/a/61265706
+html, body { background: white; }
+
+html { height: 100%; }
+
+body {
   color: black;
-  background-color: white;
   font-family: monospace;
   font-size: 1.3rem;
   line-height: 1.3;
-  -webkit-font-smoothing: antialiased;
+  margin: 0;
+  min-height: 100%;
 }
 
+.post-meta { text-align: right; }
+
 h2, h3, h4, h5, h6 { margin-top: 3rem; }
 
 hr { margin: 2rem 0; }
@@ -15,10 +42,13 @@ p { margin: 1rem 0; }
 
 li { margin: 0.4rem 0; }
 
-.wrapper {
-  max-width: 60ch;
-  margin: 4rem auto;
-  padding: 0 1rem;
+*:target { background: yellow; }
+
+.w {
+  width: fit-content;
+  max-width: 640px;
+  margin: 0 auto;
+  padding: 4rem 2rem;
 }
 
 hr {
@@ -38,7 +68,7 @@ table, th, td {
 
 code {
   color: white;
-  background-color: black;
+  background: black;
 }
 
 div.highlighter-rouge code {
@@ -53,4 +83,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.1.6
+  version: 0.4.0
 platform: ruby
 authors:
 - Riccardo Graziosi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-21 00:00:00.000000000 Z
+date: 2020-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -62,12 +62,15 @@ files:
 - LICENSE.txt
 - README.md
 - _config.yml
+- _includes/back_link.html
 - _includes/goat_counter.html
 - _includes/head.html
 - _includes/menu_item.html
 - _includes/post_list.html
+- _layouts/archive.html
 - _layouts/default.html
 - _layouts/home.html
+- _layouts/page.html
 - _layouts/post.html
 - _sass/no-style-please.scss
 - assets/css/main.scss
@@ -93,5 +96,5 @@ requirements: []
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: A (nearly) no-css minimalist Jekyll theme.
+summary: A (nearly) no-CSS, fast, minimalist Jekyll theme.
 test_files: []