Merge branch 'starter-kit' into v9

# Conflicts: # #jekyll-theme-hydejack # Gemfile.lock # assets/img/blog/COLOURlovers.com-Hydejack.png # impress.md
hydecorp · Feb 5, 2021 · bf73578 · bf73578
2 parents 53ca308 + 6a43f0a
commit bf73578
Show file tree

Hide file tree

Showing 33 changed files with 473 additions and 210 deletions.
diff --git a/.gitignore b/.gitignore
@@ -46,6 +46,7 @@ vendor
 *.gem
 _zip
 /stats.json
+/dist
 
 /assets/js/*hydejack-*
 /_sass/*/__*__/*
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,5 @@
 ---
-layout: page
+layout: plain
 sitemap: false
 ---
 
@@ -8,6 +8,135 @@ sitemap: false
 
 * this list will be replaced by the toc
 {:toc .large-only}
+
+## v9.1.0
+Feb 5 2021
+{:.heading.post-date}
+
+Version 9.1 provides minor design changes, new features, and closes multiple issues:
+
+### Added
+
+*   Code blocks now can have headers:
+
+    ~~~js
+    // file: 'hello-world.js'
+    console.log('Hello World!');
+    ~~~
+
+    To add the headers, simply make the first line a comment of the form `file: "dir/filename.ext"`.
+
+    * Code blocks now have a copy-to-clipboard button
+
+*   Resumes can now have download buttons.
+
+    ![Breadcrumbs](assets/img/blog/9.1.0-3.png){:.border}
+
+    Add the following to the front matter. Note that the PDF needs to be pre-generated. 
+    See [the docs](docs/basics.md#downloads) for more.
+
+    ```yml
+    # file: "resume.md"
+    buttons:
+      print: true
+      pdf: /assets/Resume.pdf
+      vcf: http://h2vx.com/vcf/<!--url-->
+      json: /assets/resume.json
+    ```
+
+* Added breadcrumbs above page title:
+
+  ![Breadcrumbs](assets/img/blog/9.1.0-2.png){:.border}
+
+  Note that this requires a [directory-like URL pattern](https://qwtel.com/posts/software/urls-are-directories/) like `/blog/:categories/:year-:month-:day-:title/` (default for Hydejack).
+
+  Disable with `hydejack.no_breadcrumbs`.
+
+* Added "Last modified at" to post layout:
+
+  ![Last modified at](assets/img/blog/9.1.0-1.png){:.border}
+
+  To enable this feature, the post needs to have a `last_modified_at` property with a valid date. You can either set it manually in the frontmatter (not recommended), or use the [`jekyll-last-modified-at` plugin](https://github.com/gjtorikian/jekyll-last-modified-at) to set it for you (Not available on GitHub Pages!). 
+
+  You can remove this element by setting `hide_last_modified` in the front matter. You can disable it for all posts by setting `hydejack.hide_last_modified` in the config file. Setting `hydejack.hide_dates` (PRO version only) will also remove it, together with all other time-related UI elements.
+
+  You can customize the hover text, icon, and date format in `_data/strings.yml` using the following keys: `last_modified_at` (hover text), `last_modified_at_icon` (icon name, default: `icon-history`) and `date_formats.last_modified_at` (date format, default: `%Y-%m-%d`).
+
+* Added option to "invert" / darken the font colors in the sidebar. This enables use of bright sidebar images. 
+  Set `invert_sidebar: true` in the font matter to enable. Use `defaults` in the config file to enable this for all pages.
+
+* Added a demo of [Clap Button](https://getclaps.app/) during development.
+
+* Added option to configure border radius
+* Added dingbat to `page` layout
+* Added `plain` layout that comes without a dingbat
+* Added `smaller` and `larger` CSS classes that set the font size to the respective values.
+* Added options to change the file paths to favicon and apple touch icon in the confog file. Use `favicon` and `apple_touch_icon` respectively.
+
+### Changed
+* Added border radius to many elements
+* Modernized table design
+* [PRO] Setting `hydejack.advertise: false` will now remove the banner from the HTML and the JavaScript console.
+* Changed the box shadow of cards (projects, posts) to reduce the amount of painting the browser has to do on when mouse hovering them.
+* The layout when using the theme without the `no_break_layout` setting is now
+
+
+### Fixes
+* Allow transparent project and post images
+* Removing/leaving out the `logo` key in the config file will now correctly remove the logo from the sidebar
+* [PRO] Fixed a bug that caused blog posts to be included the the search even when set to `sitemap: false` in the front matter.
+
+## v9.0.5
+Sept 8 2020
+{:.heading.post-date}
+
+* Added GitHub Pages Starter Kit to PRO version
+* Added chapter on how to deploy PRO on GitHub Pages
+* JavaScript source files now included in PRO zip again
+* Updated default config file
+* Changed default code font
+* Improved fallback image in dark mode
+
+## v9.0.4
+July 15 2020
+{:.heading.post-date}
+
+* Fixed image fade in animation for images with `srcset`
+* Slightly increased size of post and project cards
+* Added page margin to print layout
+* Fixed KaTeX when JavaScript is disabled 
+* Fixed a layout bug in the `resume` layout when changing the content width in variable
+* Fixed table of contents sticky breakpoint
+
+## v9.0.3
+July 9 2020
+{:.heading.post-date}
+
+* Updated print resume style  
+* Updated docs for GitHub Pages
+* Slightly decreased size of dark mode icon
+* Fixed a bug that caused a GitHub Pages build to fail with an empty configuration file
+* Changed default icon so that it less resembles slashdot.org\~\~ 
+
+## v9.0.2
+July 7 2020
+{:.heading.post-date}
+
+* Fixed a bug that prevented the search from updating when offline is enabled
+* Fixed a bug that caused search terms to get lost during initialization
+* Fixed a bug that prevented `site.legal` from getting stored for offline during service worker installation
+* Added support to for `no-cache` param to service worker.
+
+## v9.0.1
+July 6 2020
+{:.heading.post-date}
+
+* Changing app icons has been revamped. See [this section](./docs/config.md#adding-custom-favicons-and-app-icons) in the docs.
+* Changed default icons
+* Changed default sidebar background
+* Added `jekyll-compose` defaults to config file
+* Slightly adjusted dark mode colors
+* Fixed resume layout breakpoint
 
 ## v9.0.5
 Sept 8 2020

diff --git a/Gemfile b/Gemfile
@@ -27,17 +27,17 @@ gem "jekyll-theme-hydejack", "~> 9.0"
 gem "kramdown-math-katex"
 
 group :jekyll_plugins do
-  gem "jekyll-default-layout", git: "https://github.com/benbalter/jekyll-default-layout"
+  gem "jekyll-default-layout"
   gem "jekyll-feed"
   gem "jekyll-optional-front-matter"
   gem "jekyll-paginate"
   gem "jekyll-readme-index"
   gem "jekyll-redirect-from"
   gem "jekyll-relative-links"
-  gem "jekyll-seo-tag", git: "https://github.com/hydecorp/jekyll-seo-tag"
+  gem "jekyll-seo-tag"
   gem "jekyll-sitemap"
   gem "jekyll-titles-from-headings"
-  gem "jekyll-include-cache", git: "https://github.com/hydecorp/jekyll-include-cache"
+  gem "jekyll-include-cache"
 
   # Non-Github Pages plugins:
   gem "jekyll-last-modified-at"

diff --git a/LICENSE.md b/LICENSE.md
@@ -1,5 +1,5 @@
 ---
-layout: page
+layout: plain
 sitemap: false
 ---
 

diff --git a/NOTICE.md b/NOTICE.md
@@ -1,5 +1,5 @@
 ---
-layout: page
+layout: plain
 sitemap: false
 ---
 

diff --git a/_config.yml b/_config.yml
@@ -67,7 +67,7 @@ legal:
     url:               /CHANGELOG/
 
 # This text will appear in a `<small>` tag in the footer of every page.
-copyright:             © 2020. All rights reserved.
+copyright:             © 2021. All rights reserved.
 
 # Format of the permalinks
 permalink:             /:categories/:year-:month-:day-:title/
@@ -77,23 +77,6 @@ paginate:              10
 paginate_path:         /:num/
 
 
-# Collections
-# ----------------------------------------------------------------------------------------
-
-collections:
-  featured_categories:
-    permalink:         /:name/
-    output:            true
-
-  featured_tags:
-    permalink:         /tag-:name/
-    output:            true
-
-  projects:
-    permalink:         /projects/:path/
-    output:            true
-
-
 # Theme
 # ---------------------------------------------------------------------------------------
 
@@ -145,10 +128,10 @@ defaults:
     values:
       sitemap:         false
 
-  # Don't include licenses in sitemap (feel free to delete)
   - scope:
       path:            licenses/
     values:
+      layout:          plain
       sitemap:         false
 
   # # You can use the following to enable comments on all posts.
@@ -176,7 +159,7 @@ defaults:
         type:          WebPage
 
 kramdown:
-  math_engine:         katex
+  math_engine:         mathjax
   math_engine_opts:    {}
   footnote_backlink:   '&#x21a9;&#xfe0e;'
 
@@ -258,12 +241,15 @@ hydejack:
   # This only affects the meta tag, not the color specified in the app manifest.
   no_theme_color:      false
 
+  # Disable the breadcrumbs above the title
+  no_breadcrumbs:      false
+
   # Set to `true` when building with the `--lsi` option
   use_lsi:             true
 
   # When using Google Analytics, set to `true` to display a cookie notice banner.
   # When enabled, no user-related data will be stored until the user gives consent.
-  cookies_banner:      true
+  cookies_banner:      false
 
   # Set to `true` if you would like to add a "Powered by Hydejack" link in the footer.
   # Note that this setting has no effect when using the free version.
@@ -274,6 +260,9 @@ hydejack:
   # seeing an old date. 
   hide_dates:          false
 
+  # TODO
+  hide_last_modified:  false
+
   # Note that dark mode only works in the PRO version of Hydejack.
   dark_mode:
     # Set to `true` to always use the dark theme.
@@ -291,17 +280,35 @@ hydejack:
   # Only use if you know what Service Workers are and how they can impact your site!
   offline:
     enabled:           false
-    cache_version:     7
+    cache_version:     13
     precache_assets:
       - /assets/img/swipe.svg
 
 
+# Collections
+# ----------------------------------------------------------------------------------------
+
+collections:
+  featured_categories:
+    permalink:         /:name/
+    output:            true
+
+  featured_tags:
+    permalink:         /tag-:name/
+    output:            true
+
+  projects:
+    permalink:         /projects/:path/
+    output:            true
+
+
 # File inclusion/exclusion
 # ----------------------------------------------------------------------------------------
 
 exclude:
   - .jekyll-cache
   - .sass-cache
+  - '*.toml'
   - vendor
   - Gemfile
   - Gemfile.lock

diff --git a/_data/strings.yml b/_data/strings.yml
@@ -21,13 +21,14 @@ jump_to:               Jump to
 navigation:            Navigation
 social:                Social
 links:                 Links
+links_icon:            'icon-link'
 pagination:            Pagination
 newer:                 Newer
 older:                 Older
 forward:               Forward
 back:                  Back
 permalink:             Permalink
-permalink_icon:        content-hash
+permalink_icon:        'content-hash'
 templates:             Templates (for web app)
 present:               present
 toc:                   Table of Contents
@@ -69,18 +70,23 @@ error:
 # Separators
 # ---------------------------------------------------------------------------------------
 posted:                'Posted'
+last_modified_at:      'Last modified at'
+last_modified_at_icon: 'icon-history'
 colon:                 ':'
 separator:             '|'
 category_start:        'in '
 category_spearator:    ' / '
 tag_start:             'on '
 tag_separator:         ', '
 from_to_separator:     '–'
+breadcrumbs_home:      'home'
+breadcrumbs_separator: '/'
 
 # Date formats
 # ---------------------------------------------------------------------------------------
 date_formats:
   post:                '%d %b %Y'
+  last_modified_at:    '%Y-%m-%d'
   related_post:        '%d %b %Y'
   list_group_by:       '%Y'
   list_entry:          '%d %b'

diff --git a/_data/variables.yml b/_data/variables.yml
@@ -16,6 +16,7 @@
   content_width_5: 54 #rem
 
   sidebar_width: 21 #rem
+  border_radius: 0.5 #rem
 
   break_point_1: 42 #em
   break_point_2: 54 #em

diff --git a/_includes/features.md b/_includes/features.md
@@ -14,7 +14,10 @@ An incomplete list of features included in all versions of **Hydejack**:
 * Built-in icons for many social networks
 * Simple and semantic HTML + Structured Data
 * Google Analytics and Google Fonts support
+* Works with GitHub Pages out of the box[^12]
 
-[^11]: Actual page load speed depends on your hosting provider, resolution of embedded images and usage of 3rd party plugins.
+[^11]: Actual page load speed depends on your hosting provider, location, resolution and format of images, usage of 3rd party plugins, and other factors.
+
+[^12]: Some limitations apply, most notably the need to use use MathJax instead of KaTeX for math block rendering.
 
 *[FLIP]: First-Last-Invert-Play. A coding technique to achieve performant page transition animations.
diff --git a/_includes/my-body.html b/_includes/my-body.html
@@ -1,3 +1,17 @@
+<!-- <script>
+  document.querySelector('hy-push-state').setAttribute('prefetch', '');
+
+  document.querySelectorAll('.sidebar a[href^="/"]').forEach(function (el) { 
+    el.addEventListener('click', function (e) {
+      if (el.pathname === window.location.pathname) {
+        e.preventDefault();
+        e.stopPropagation();
+        document.querySelector('hy-drawer').close();
+      }
+    });
+  });
+</script> -->
+
 <!--
 Code for integrating CloudFlare's email protection with Hydejack's single page app loading.
 -->
@@ -57,9 +71,9 @@
 <script>
   var _paq = _paq || [];
 
-  {% if site.matomo_analytics.no_cookies %}
+  /*{% if site.matomo_analytics.no_cookies %}*/
   _paq.push(['disableCookies']);
-  {% endif %}
+  /*{% endif %}*/
 
   _paq.push(['trackPageView']);
   _paq.push(['enableLinkTracking']);