bulma-clean-theme 0.5.7 → 0.5.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4335d8b6a8d652079788478438805fd03081572d
-  data.tar.gz: 3fbe6b6916d8ac0ed98141b98a92c8bb6e2ca7fc
+SHA256:
+  metadata.gz: e069b6f5f4713ef53a9c89a4e07354aac95fca301a373de6093198b775d29f18
+  data.tar.gz: dde5ae8ba40555625f418a87cfe97f4cf50a025883027edae3c120899b3e1eea
 SHA512:
-  metadata.gz: bd6135733dea3ab2b66e36eef39944430dcf64c2e218a9f08a7c13a41a00d2b0c68b0a27db2000e0682ae51ad26b3ce4d9b426e1484591b09ac7405d4e70ef38
-  data.tar.gz: e6827ebf74c9f8bb6b45d798f18fb3a1beae2632fa3d634a2faa51b0d0fc9714a03e79ecdaafa6abd245e1fb192bbb13a1a6aa659635b46dddb5b85a4956a6cf
+  metadata.gz: 1dac119dc60f87b25792e3c8684f37ffb35e91cb8ef19e0ac74be6205a7ab9b31533d1462241a1849ca75cd9139d924bc3f5dc00557d324c78460a4aa5fd6317
+  data.tar.gz: 185cd417afa785a674734f415aec7f7f352c2a09ba20ac8d6fd321b5029f94ce82fb1eac222e8006eb6087c8c1dad18c643a38a931ee32ca12eade09c4033e3e

data/README.md

@@ -10,6 +10,8 @@ This is a clean and simple Jekyll Theme built with the [Bulma](https://bulma.io/
 * [Installation](#installation)
 * [Usage](#usage)
     * [Pages](#pages)
+        * [Page Hero](#page-hero)
+        * [Table Of Contents](#table-of-contents)
     * [Posts](#posts)
     * [Navigation](#navigation)
     * [Colours and Styles](#colours-and-styles)
@@ -21,6 +23,7 @@ This is a clean and simple Jekyll Theme built with the [Bulma](https://bulma.io/
     * [Products](#products)
     * [Scripts](#scripts)
     * [Callouts](#callouts)
+    * [Favicon](#favicon)
 * [Contributing](#contributing)
 * [Development](#development)
 * [Licence](#licence)
@@ -52,26 +55,33 @@ Or install it yourself as:
 
 ### Pages 
 
-Create your pages as individual markdown files and use the `layout: page` for normal pages. Set the pages title and subtitle in the frontmatter and it will appear in the hero.
+Create your pages as individual markdown files and use the `layout: page` for normal pages. Set the pages title and subtitle in the front matter and it will appear in the hero.
+
+#### Page Hero
 
 **New in 0.2** 
-Heros can now display a background image if you provide a `hero_image: /path/to/image.jpg` setting in your page frontmatter, or in the [defaults](https://jekyllrb.com/docs/configuration/front-matter-defaults/) in your sites `_config.yml`
+Heros can now display a background image if you provide a `hero_image: /path/to/image.jpg` setting in your page front matter, or in the [defaults](https://jekyllrb.com/docs/configuration/front-matter-defaults/) in your sites `_config.yml`
 
-You can also set the height of the hero by providing a bulma hero height class in your frontmatter, such as `hero_height: is-fullwidth`. If you do not provide this, it will revert to is-medium 
+You can also set the height of the hero by providing a bulma hero height class in your front matter, such as `hero_height: is-fullwidth`. If you do not provide this, it will revert to is-medium 
 
 **New in 0.5.4**
-If you would like to add a call to action button in the hero then add `hero_link` and `hero_link_text` to the page's frontmatter.
+If you would like to add a call to action button in the hero then add `hero_link` and `hero_link_text` to the page's front matter.
 
 **New in 0.5.7**
-If you would like to hide the hero, you can set `hide_hero: true` in the page's frontmatter.
+If you would like to hide the hero, you can set `hide_hero: true` in the page's front matter.
+
+#### Table Of Contents
+
+**New in 0.5.8**
+If you want to display a table of contents (toc) then add `toc: true` to your page's front matter. You can customise the default table of contents title by setting `toc_title: My Custom Title` in the page's front matter. 
 
 ### Posts
 
 If you want posts, create a `_posts` directory to store your posts as per normal Jekyll usage, with the `layout: post`. Next create a `blog` directory with an index.html file that has `layout: blog`
 
-**New in 0.2** It will now display an image in the blog page if you set `image: /path/to/image.jpg` in your post's or page's frontmatter, or in the [defaults](https://jekyllrb.com/docs/configuration/front-matter-defaults/) in your sites `_config.yml`
+**New in 0.2** It will now display an image in the blog page if you set `image: /path/to/image.jpg` in your post's or page's front matter, or in the [defaults](https://jekyllrb.com/docs/configuration/front-matter-defaults/) in your sites `_config.yml`
 
-You can also set the height of the hero by providing a bulma hero height class in your frontmatter, such as `hero_height: is-fullwidth`. If you do not provide this, it will revert to is-medium
+You can also set the height of the hero by providing a Bulma hero height class in your front matter, such as `hero_height: is-fullwidth`. If you do not provide this, it will revert to is-medium
 
 
 ### Navigation
@@ -175,7 +185,7 @@ You may make multiple menus in the same file, separated by the label
 
 **New in 0.4**
 
-The tabs gets its content from a data file in your site's `_data` directory. Simply set the name of your data file in the page's menubar setting in the frontmatter. 
+The tabs gets its content from a data file in your site's `_data` directory. Simply set the name of your data file in the page's menubar setting in the front matter. 
 
 ```yaml
 title: Page with tabs
@@ -384,6 +394,10 @@ subtitle: This is an example landing page
 callouts: example_callouts
 ```
 
+### Favicon
+
+The default favicon path is `{{ site.baseurl }}/favicon.png` but you can overwrite it in the sites `_config.yml` like this `favicon: /path/to/favicon.png`
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/chrisrhymes/bulma-clean-theme. 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.

data/_includes/head.html

@@ -3,7 +3,9 @@
     <meta name="viewport" content="width=device-width, initial-scale=1">
     <title>{{ page.title }} - {{ site.title }}</title>
     <link rel="stylesheet" href="{{ site.baseurl }}/assets/css/app.css">
-    <link rel="shortcut icon" type="image/png" href="{{ site.baseurl }}/favicon.png" />
+    <link rel="shortcut icon" type="image/png"
+          {% if site.favicon %} href="{{ site.favicon | prepend: site.baseurl }}" {% else %} href="{{ site.baseurl }}/favicon.png" {% endif %}
+    />
     <script defer src="https://use.fontawesome.com/releases/v5.3.1/js/all.js"></script>
     {% seo %}
     {%- if site.google_analytics -%}

data/_includes/toc.html

@@ -0,0 +1,82 @@
+{% capture tocWorkspace %}
+    {% comment %}
+        Version 1.0.8
+          https://github.com/allejo/jekyll-toc
+    {% endcomment %}
+
+    {% capture my_toc %}{% endcapture %}
+    {% assign orderedList = include.ordered | default: false %}
+    {% assign minHeader = include.h_min | default: 1 %}
+    {% assign maxHeader = include.h_max | default: 6 %}
+    {% assign nodes = include.html | split: '<h' %}
+    {% assign firstHeader = true %}
+
+    {% capture listModifier %}{% if orderedList %}1.{% else %}-{% endif %}{% endcapture %}
+
+    {% for node in nodes %}
+        {% if node == "" %}
+            {% continue %}
+        {% endif %}
+
+        {% assign headerLevel = node | replace: '"', '' | slice: 0, 1 | times: 1 %}
+
+        {% if headerLevel < minHeader or headerLevel > maxHeader %}
+            {% continue %}
+        {% endif %}
+
+        {% if firstHeader %}
+            {% assign firstHeader = false %}
+            {% assign minHeader = headerLevel %}
+        {% endif %}
+
+        {% assign indentAmount = headerLevel | minus: minHeader %}
+        {% assign _workspace = node | split: '</h' %}
+
+        {% assign _idWorkspace = _workspace[0] | split: 'id="' %}
+        {% assign _idWorkspace = _idWorkspace[1] | split: '"' %}
+        {% assign html_id = _idWorkspace[0] %}
+
+        {% assign _classWorkspace = _workspace[0] | split: 'class="' %}
+        {% assign _classWorkspace = _classWorkspace[1] | split: '"' %}
+        {% assign html_class = _classWorkspace[0] %}
+
+        {% if html_class contains "no_toc" %}
+            {% continue %}
+        {% endif %}
+
+        {% capture _hAttrToStrip %}{{ _workspace[0] | split: '>' | first }}>{% endcapture %}
+        {% assign header = _workspace[0] | replace: _hAttrToStrip, '' %}
+
+        {% assign space = '' %}
+        {% for i in (1..indentAmount) %}
+            {% assign space = space | prepend: '    ' %}
+        {% endfor %}
+
+        {% unless include.item_class == blank %}
+            {% capture listItemClass %}{:.{{ include.item_class | replace: '%level%', headerLevel }}}{% endcapture %}
+        {% endunless %}
+
+        {% capture heading_body %}{% if include.sanitize %}{{ header | strip_html }}{% else %}{{ header }}{% endif %}{% endcapture %}
+        {% capture my_toc %}{{ my_toc }}
+{{ space }}{{ listModifier }} {{ listItemClass }} [{{ heading_body | replace: "|", "\|" }}]({% if include.baseurl %}{{ include.baseurl }}{% endif %}#{{ html_id }}){% if include.anchor_class %}{:.{{ include.anchor_class }}}{% endif %}{% endcapture %}
+    {% endfor %}
+
+    {% if include.class %}
+        {% capture my_toc %}{:.{{ include.class }}}
+{{ my_toc | lstrip }}{% endcapture %}
+    {% endif %}
+
+    {% if include.id %}
+        {% capture my_toc %}{: #{{ include.id }}}
+{{ my_toc | lstrip }}{% endcapture %}
+    {% endif %}
+{% endcapture %}{% assign tocWorkspace = '' %}
+
+<div class="contents">
+    <div class="menu">
+        <p class="menu-label">{{ include.contents_title }}</p>
+        {{ my_toc | markdownify | strip }}
+    </div>
+</div>
+
+

data/_layouts/page.html

@@ -2,6 +2,10 @@
 layout: default
 ---
 
+{% if page.toc %}
+    {% assign contentsTitle = page.toc_title | default: 'Contents' %}
+    {% include toc.html html=content class='menu-list' h_min=2 h_max=3 contents_title=contentsTitle %}
+{% endif %}
 <div class="content">
     {{ content }}
 </div>

data/_sass/_layout.scss

@@ -23,3 +23,9 @@ div.highlight {
         }
     }
 }
+
+.contents {
+    box-shadow: $box-shadow;
+    padding: 1.5rem;
+    margin-bottom: 3rem;
+}

data/_sass/_main.scss

@@ -9,4 +9,4 @@ $tabs-link-active-border-bottom-color: $primary;
 
 @import "../node_modules/bulma/bulma.sass";
 @import "layout";
-@import "syntax"
+@import "syntax";

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bulma-clean-theme
 version: !ruby/object:Gem::Version
-  version: 0.5.7
+  version: 0.5.8
 platform: ruby
 authors:
 - chrisrhymes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-14 00:00:00.000000000 Z
+date: 2019-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -160,6 +160,7 @@ files:
 - _includes/rating.html
 - _includes/review.html
 - _includes/tabs.html
+- _includes/toc.html
 - _layouts/blog.html
 - _layouts/default.html
 - _layouts/page.html
@@ -175,7 +176,6 @@ files:
 - assets/css/app.scss
 - assets/js/app.js
 - blog/index.html
-- changelog.txt
 - favicon.png
 - node_modules/.yarn-integrity
 - node_modules/bulma/CHANGELOG.md
@@ -261,9 +261,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Clean and simple theme using Bulma
+summary: Clean and simple Jekyll theme built using Bulma
 test_files: []

data/changelog.txt

@@ -1,41 +0,0 @@
-# 0.5.7
-* Add option to hide hero - pull request #15 from risa2000
-* Add ability to override the height of callouts - pull request #14 from agardnerIT
-
-# 0.5.6
-* Explicitly reference shortcut icon - pull request #13 from johannesegger
-
-# 0.5.5
-* Fix bug with navbar dropdown in IE and Edge
-* Fix bug with layout where <code> elements were too wide
-
-# 0.5.4
-* Added landing page feature
-
-# 0.5.3
-* Remove extra </a> - pull request #8 from SumitBando
-
-# 0.5.2
-* Add head and footer script partials
-* Updated Bulma to 0.7.5
-
-# 0.5.1
-* Fix headings not showing in post
-
-# 0.5
-* Add product page layouts
-
-# 0.4.1
-* Added footer links
-
-# 0.4
-* Added tabs, syntax highlighting and updated Bulma
-
-# 0.3
-* Added menubar
-
-# 0.2
-* Added hero background image, blog page images and Google Analytics
-
-# 0.1
-* Initial release