type-on-strap 2.5.1 → 2.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ccb4fee6ac8c69a532174663a2a2c0dcfad5725c42a4f31ecf1d109e8319a170
-  data.tar.gz: ca86903243c9c9b1d660b03962853a7db7b156dbd5f76b5af17e2535734f2a7d
+  metadata.gz: f5a9d47621e0b454f1c0658622a29f749519ddd6dd265cdcbf1ead4f210fa9e2
+  data.tar.gz: 065cb8d35e79a304c0530008c4494c8ce1d1e64ed88d9422a5eeec03737145ea
 SHA512:
-  metadata.gz: 4de654f0b9e47747ada241f063797864252a72705eb543e252da6c0270e1fcc178328170192095372504095eb05d0f5a1f0132eb55d563049087d27f454a6b6c
-  data.tar.gz: ff886caa5eb1c059b8a9df3e175349f6b701059f09fe8cfa071e688aedb0d8552b98de4229df9417c38292ac6973dabf1984b6515106cbca0ac96af2e378a386
+  metadata.gz: bf956f01a7160cc092808515301fa639b07a48a000a987f74536ac6d792972f14e494898f4a7ea8527b3ea342f33ceb4575a8ceac252e03429e9a1e6de9dc50b
+  data.tar.gz: b55fd5b2f2b114913c38c1b6b4113647c621c88d5522b09aea4e45f9316cca6f822665e086b146b374579d39e3cd025e08e7ef3dd18de2218e000e95a0b21b93

data/README.md

@@ -3,34 +3,41 @@
 [![Build](https://github.com/sylhare/Type-on-Strap/actions/workflows/docker-build.yml/badge.svg)](https://github.com/sylhare/Type-on-Strap/actions/workflows/docker-build.yml)
 [![Gem Version](https://badge.fury.io/rb/type-on-strap.svg)](https://badge.fury.io/rb/type-on-strap)
 [![Docker Pulls](https://img.shields.io/docker/pulls/sylhare/type-on-strap)](https://hub.docker.com/r/sylhare/type-on-strap)
+[![Gem Downloads](https://img.shields.io/gem/dt/type-on-strap?logo=rubygems)](https://rubygems.org/gems/type-on-strap)
 
-[![Default Type on Strap blog](https://github.com/Sylhare/Type-on-Strap/blob/master/assets/img/screenshot.png?raw=true)](https://sylhare.github.io/Type-on-Strap/)
+[![Default Type on Strap blog](https://github.com/sylhare/Type-on-Strap/blob/master/assets/img/screenshot.png?raw=true)](https://sylhare.github.io/Type-on-Strap/)
 
-A free and open-source [Jekyll](https://jekyllrb.com) theme. 
-Based on Rohan Chandra [type-theme](https://github.com/rohanchandra/type-theme) packed with extra features and easily customizable:
+A feature-rich [Jekyll](https://jekyllrb.com) theme for writers, developers, and creatives — with portfolio, gallery, dark mode, search, KaTeX, and Mermaid out of the box.
 
 * Responsive design on all devices (🖥, 💻, 📱, ...)
-* Portfolio 🗂, Gallery 🖼 pages for your projects
-* Multi comments 💬 options  
-* Tags compatibility 🏷
-* Handle _Bootstrap_'ed pages: [Get Bootstrap](http://getbootstrap.com/)
-* 🔎 Search feature: [Simple-Jekyll-Search](https://github.com/sylhare/Simple-Jekyll-Search)
-* Math Rendering : [KateX](https://github.com/Khan/KaTeX)
-* Diagram Rendering: [Mermaid-js](https://github.com/mermaid-js/mermaid)
-* 🖋 Nice fonts: [Font Awesome](https://fontawesome.com/), [Source Sans Pro](https://fonts.google.com/specimen/Source+Sans+Pro), [Pacifico](https://fonts.google.com/specimen/Pacifico?selection.family=Pacifico) 
-* Seo Tags: [Jekyll-seo-tag](https://github.com/jekyll/jekyll-seo-tag)
-* 🛠 Syntax Highlighting: Easily customisable [Base16](https://github.com/chriskempson/base16)
-* 💡 Light and dark theme supported
-* Find free of rights images on [pexels](https://www.pexels.com/)
-
-> [Demo Site](https://sylhare.github.io/Type-on-Strap/) 
+* Portfolio 🗂 and Gallery 🖼 pages for your projects
+* Auto light and dark theme 💡 with manual toggle
+* Full-text 🔎 search: [Simple-Jekyll-Search](https://github.com/sylhare/Simple-Jekyll-Search)
+* Write equations natively with [KaTeX](https://github.com/Khan/KaTeX)
+* Render diagrams natively with [Mermaid](https://github.com/mermaid-js/mermaid)
+* Multi comments 💬 systems: Disqus, Giscus, Utterances, Cusdis
+* Compatible with [Bootstrap](http://getbootstrap.com/) for responsive, customizable layouts
+* SEO-ready with [jekyll-seo-tag](https://github.com/jekyll/jekyll-seo-tag)
+* Syntax highlighting with easily customizable [Base16](https://github.com/chriskempson/base16) themes
+* Tags 🏷, categories, archive, and pagination built in
+
+> [Demo Site](https://sylhare.github.io/Type-on-Strap/)
 
 ## Usage
 
+### As a remote theme 🌐
+
+The easiest way to use Type-on-Strap is as a remote theme with GitHub Pages.
+Add this to your [`_config.yml`](_config.yml):
+
+```yml
+remote_theme: sylhare/Type-on-Strap
+```
+
 ### As a GitHub page 📋
 
-1. Fork and clone the [Type on Strap repo](https://github.com/sylhare/Type-On-Strap): `git clone https://github.com/Sylhare/Type-on-Strap.git`
-2. Install [Jekyll](https://jekyllrb.com/docs/installation/): `gem install jekyll`, check [#1](https://github.com/Sylhare/Type-on-Strap/issues/1) if you have a problem.
+1. Fork and clone the [Type on Strap repo](https://github.com/sylhare/Type-on-Strap): `git clone https://github.com/sylhare/Type-on-Strap.git`
+2. Install [Ruby](https://www.ruby-lang.org/en/documentation/installation/) and [Bundler](https://bundler.io/), check [#1](https://github.com/sylhare/Type-on-Strap/issues/1) if you have a problem.
 3. Install the theme's dependencies: `bundle install`
 4. Customize the theme
 	- GitHub Page: [update `_config.yml`](#site-configuration)
@@ -59,6 +66,8 @@ Here are the main files of the template
 ├── pages
 |   ├── 404.md		       # To be displayed when url is wrong
 |   ├── about.md               # About example page
+|   ├── archive.md             # Archive page for all posts
+|   ├── categories.md          # Categories page for all posts
 |   ├── gallery.md             # Gallery page for your photos
 |   ├── portfolio.md	       # Portfolio page for your projects
 |   ├── search.md	       # Search page
@@ -67,10 +76,12 @@ Here are the main files of the template
 ├── _data
 |  ├── authors.yml             # Update the post authors configurations 
 |  ├── comments.yml            # Comments configuration (Disqus, Cusdis, Utterances, Giscus)
+|  ├── icons.yml               # Footer icons (Twitter, Github, Stackoverflow, ...)
+|  ├── icons_builder.yml       # Icon set builder configuration
 |  ├── language.yml            # Localization configuration
+|  ├── menu.yml                # Navigation menu configuration
 |  ├── biblio.yml              # To create a reference bibliography
 |  ├── social.yml              # Social configurations to share posts (RSS, shares, ...)
-|  └── icons.yml               # Footer icons (Twitter, Github, Stackoverflow, ...)
 └── index.html                 # sample home page (blog page paginated)
 ```
 	
@@ -322,7 +333,7 @@ They will on click redirect you to the logo's platform to share the article.
 Display icons in the footer. 
 All icon variables should be your username enclosed in quotes (e.g. "username") in [`_data/icons.yml`](_data/icons.yml).
 
-You can update the RSS settings in `_data/social` to change the default feed path (generated by [jekyll-feel](https://github.com/jekyll/jekyll-feed)).
+You can update the RSS settings in `_data/social` to change the default feed path (generated by [jekyll-feed](https://github.com/jekyll/jekyll-feed)).
 To enable the share icons at the bottom of each article,
 set to true the one you'd like under `share` in the [`_data/social.yml`](_data/social.yml) file.
 
@@ -423,7 +434,7 @@ of your favourite highlight color scheme on this format.
 
 ## Feature pages and layouts 
 
-All feature pages besides the "home" one are stored in the `page` folder, 
+All feature pages besides the "home" one are stored in the `pages` folder, 
 they will appear in the navigation bar unless you set `Hide: true` in the front matter. 
 
 Here are the documentation for the other feature pages that can be added through [`_config.yml`](_config.yml). 
@@ -478,7 +489,7 @@ layout: page
 title : Portfolio 
 ---
 
-{% include default/portfolio.html %}
+{% include portfolio.html %}
 ```
 
 #### Portfolio posts
@@ -529,7 +540,7 @@ title: Gallery
 gallery: "assets/img/pexels"
 ---
 
-{% include default/gallery.html gallery_path=page.gallery %}
+{% include gallery.html gallery_path=page.gallery_path %}
 ```
 
 ### Feature: Search 🔍
@@ -629,18 +640,15 @@ Then you can start adding content like:
   - Add the feature page you want. (ex: as it is already in `pages`)
   - Add posts in `_posts` and `_portfolio` to be displayed
 
-### Remote Theme
-
-Now you can use any theme gem with GitHub pages with [29/11/2017 GitHub Pages Broadcast](https://github.com/blog/2464-use-any-theme-with-github-pages).
-For that remove all `theme:` attributes from [`_config.yml`](_config.yml) and add instead:
-
-```yml
-remote_theme: sylhare/Type-on-Strap 
-```
-
 ## License
 
 This theme is licensed under the [MIT License (MIT)](/LICENSE)
 
 - Pictures from [Pexels](https://www.pexels.com/) are under Creative Commons Zero (CC0) license
 - Fonts are licensed under the [SIL Open Font License (OFL)](https://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&id=OFL)
+
+## Credits
+
+Based on Rohan Chandra's [type-theme](https://github.com/rohanchandra/type-theme), extended with many additional features.
+
+[![Contributors](https://contrib.rocks/image?repo=sylhare/Type-on-Strap)](https://github.com/sylhare/Type-on-Strap/graphs/contributors)

data/_includes/default/head.liquid

@@ -18,6 +18,11 @@
     <!-- Main JS (navbar.js, katex_init.js)-->
     <script defer src="{{ '/assets/js/main.min.js' | relative_url }}"></script>
 
+    {% if page.bootstrap %}
+    <!-- Bootstrap 4.6.2 CSS CDN - loaded in a @layer so theme styles always take precedence -->
+    <style>@import url("https://cdn.jsdelivr.net/npm/bootstrap@4.6.2/dist/css/bootstrap.min.css") layer(bootstrap);</style>
+    {% endif %}
+
     <!-- CSS -->
     <link rel="stylesheet" href="{{ '/assets/css/main.css' | relative_url }}">
 
@@ -30,8 +35,6 @@
     {% endif %}
 
     {% if page.bootstrap %}
-    <!-- Bootstrap 4.6.2 CSS CDN -->
-    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap@4.6.2/dist/css/bootstrap.min.css" integrity="sha384-xOolHFLEh07PJGoPkLv1IbcEPTNtaed2xpHsD9ESMhqIYd0nLMwNLD69Npy4HI+N" crossorigin="anonymous">
     <!-- jQuery 3.5.1 CDN -->
     <script defer src="https://cdn.jsdelivr.net/npm/jquery@3.5.1/dist/jquery.slim.min.js" integrity="sha384-DfXdz2htPH0lsSSs5nCTpuj/zy4C+OGpamoFVy38MVBnE+IbbVYUew+OrCXaRkfj" crossorigin="anonymous"></script>
     <!-- Popper.js 1.16.1 CDN -->
@@ -40,18 +43,18 @@
     <script defer src="https://cdn.jsdelivr.net/npm/bootstrap@4.6.2/dist/js/bootstrap.min.js" integrity="sha384-+sLIOodYLS7CIrQpBjl+C7nPvqq+FbZUBVs2mbGk8cFoTfurqEOk6sD3+6VUuY3" crossorigin="anonymous"></script>
     {% endif %}
 
-    <!-- KaTeX 0.16.38 -->
+    <!-- KaTeX 0.17.0 -->
     {% if site.katex or site.theme_settings.katex %}
     <script defer src="{{ '/assets/js/vendor/katex.min.js' | relative_url }}"></script>
     <script defer src="{{ '/assets/js/vendor/katex.auto-render.min.js' | relative_url }}" onload="renderMathInElement(document.body);"></script>
     {% endif %}
 
-    <!-- Mermaid 11.13.0 -->
+    <!-- Mermaid 11.15.0 -->
     {% if site.mermaid %}
     <script defer src="{{ '/assets/js/vendor/mermaid.min.js' | relative_url }}"></script>
     {% endif %}
 
-    <!-- Simple-Jekyll-Search 2.1.3 -->
+    <!-- Simple-Jekyll-Search 2.1.4 -->
     <script src="{{ '/assets/js/vendor/simple-jekyll-search.min.js' | relative_url }}" type="text/javascript"></script>
 
     <!-- Google Analytics / Cookie Consent -->

data/_layouts/default.html

@@ -1,6 +1,6 @@
 <!DOCTYPE html>
 <!--
-    Type on Strap jekyll theme v2.5.1
+    Type on Strap jekyll theme v2.5.2
     Theme free for personal and commercial use under the MIT license
     https://github.com/sylhare/Type-on-Strap/blob/master/LICENSE
 -->

data/_layouts/page.liquid

@@ -15,7 +15,9 @@ layout: default
         </div>
     </header>
     <section class="post-content">
+        {% if page.bootstrap %}<div class="bootstrap-iso">{% endif %}
         {{ content }}
+        {% if page.bootstrap %}</div>{% endif %}
     </section>
     <!-- Category and Tag list -->
     <div class="tag-category-container">

data/_layouts/post.liquid

@@ -14,7 +14,9 @@ layout: default
     </header>
 
     <section class="post-content">
+        {% if page.bootstrap %}<div class="bootstrap-iso">{% endif %}
         {{ content }}
+        {% if page.bootstrap %}</div>{% endif %}
     </section>
 
     <!-- Social media shares -->

data/_layouts/search.liquid

@@ -20,6 +20,7 @@ layout: page
             strategy: {
                 type: 'hybrid',
             },
+            sortMiddleware: window.RelevanceSort,
             exclude: [],
             templateMiddleware: window.createHighlightTemplateMiddleware({
                 className: 'search-highlight',

data/_sass/base/_global.scss

@@ -8,7 +8,8 @@ figure {
   margin: 0;
 }
 
-html {
+html,
+body {
   background: var(--background);
 }
 

data/_sass/external/_katex.scss

@@ -1,5 +1,5 @@
 /*!
- * KaTeX v0.16.38
+ * KaTeX v0.17.0
  * Plus added customizations for the theme
  */
 

data/_sass/external/katex/katex.scss

@@ -144,6 +144,7 @@ $katex-font-path: "../../assets/fonts/katex" !default;
 .katex {
   font: normal 1.21em KaTeX_Main, Times New Roman, serif;
   line-height: 1.2;
+  position: relative;
   text-indent: 0;
   text-rendering: auto;
 }
@@ -154,13 +155,14 @@ $katex-font-path: "../../assets/fonts/katex" !default;
   border-color: currentColor;
 }
 .katex .katex-version::after {
-  content: "0.16.38";
+  content: "0.17.0";
 }
 .katex .katex-mathml {
   /* Accessibility hack to only show to screen readers
    Found at: http://a11yproject.com/posts/how-to-hide-content/ */
   position: absolute;
-  clip: rect(1px, 1px, 1px, 1px);
+  -webkit-clip-path: inset(50%);
+          clip-path: inset(50%);
   padding: 0;
   border: 0;
   height: 1px;
@@ -388,8 +390,8 @@ $katex-font-path: "../../assets/fonts/katex" !default;
 .katex .sqrt > .root {
   /* These values are taken from the definition of `\r@@t`,
    `\mkern 5mu` and `\mkern -10mu`. */
-  margin-left: 0.2777777778em;
-  margin-right: -0.5555555556em;
+    margin-left: 0.2777777778em;
+    margin-right: -0.5555555556em;
 }
 .katex .sizing.reset-size1.size1,
 .katex .fontsize-ensurer.reset-size1.size1 {