bulma-clean-theme 0.6.5 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4a5505a4156aeaf53333ead0a735d3c61ce881dd
-  data.tar.gz: 8b5c1e7614ea4cf424b7dedcda300608a4e6828e
+  metadata.gz: 365edf96f993fdb04ab7a6a17438e902546e21b7
+  data.tar.gz: 88e83adb658f7cda5708136893e8b0f98f3fc004
 SHA512:
-  metadata.gz: 146339e34ab8f39fa2901f85ae3060c705ef0a99b6575db7adb40d9303376652a861d5a15865fc0e5d5dea629eab5f10ee04f6ba06edd978f62bb431e45a4bdb
-  data.tar.gz: 4aef8ea9d72f15bc7dc1a5a00a1a019bc8160d9b975ab6a6b31fbc8e734d6b4f0c8b7805733c07f0979a49604c08694904acebddd661dafa90055f42be599433
+  metadata.gz: 5bad6e57b63ca40367551dba6f41a881db24871bb643dd61de2a9df24f26585adb40c9635356ba65576219b4bb9645ee4fcd2f147b9aeebd67514ec94edb6d6a
+  data.tar.gz: 3242a63eca3d967ab9902e3f74de37660044a26c4ff56dab6bdf1a2011f68fcb9c51032c11acd69f720939a6c50a9b1eddbedb978152eb3068226c9754aa41a8

data/README.md

@@ -25,6 +25,7 @@ This is a clean and simple Jekyll Theme built with the [Bulma](https://bulma.io/
     * [Callouts](#callouts)
     * [Favicon](#favicon)
     * [Showcases](#showcases)
+    * [Sponsors](#sponsors)
     * [Disqus](#disqus)
 * [Contributing](#contributing)
 * [Development](#development)
@@ -33,6 +34,8 @@ This is a clean and simple Jekyll Theme built with the [Bulma](https://bulma.io/
 
 ## Installation
 
+**This theme requires Jekyll 3.8 so it is compatible with GitHub Pages.**
+
 Add this line to your Jekyll site's `Gemfile`:
 
 ```ruby
@@ -72,6 +75,9 @@ If you would like to add a call to action button in the hero then add `hero_link
 **New in 0.5.7**
 If you would like to hide the hero, you can set `hide_hero: true` in the page's front matter.
 
+**New in 0.7.1**
+If you would like to darken the hero so the title stands out more, you can set `hero_darken: true` in the page's front matter. You can overwrite the default background colour by setting the `$hero-darken` sass variable.
+
 #### Table Of Contents
 
 **New in 0.5.8**
@@ -92,6 +98,10 @@ paginate_path: "/blog/page:num"
 
 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
 
+#### Social Share Buttons
+
+Share buttons will be displayed on your posts unless you hide them by adding `hide_share_buttons: true` to your config file.
+
 
 ### Navigation
 
@@ -375,7 +385,7 @@ Create a data file following the below format. The style is for classes to set t
 
 **New in 0.5.7** You can set the height of the callouts in the data file, such as is-small, is-medium or is-large. If unset it will be is-medium by default.
 
-The items have 5 fields, but only the title and subtitle are required. 
+The items have 6 fields, but only the title and subtitle are required. If the icon is a brand icon, such as GitHub in the below example, set `icon_brand: true`.
 
 ```yaml
 style: is-light
@@ -383,7 +393,8 @@ height: is-medium
 items:
   - title: Example callout 1
     subtitle: Example subtitle 1
-    icon: fa-space-shuttle
+    icon: fa-github
+    icon_brand: true
     description: >
       The example description text goes here and can be multiple lines.
 
@@ -459,6 +470,52 @@ showcase: showcase_example
 show_sidebar: false
 ```
 
+### Sponsors
+
+#### Sponsor link in navbar
+
+If you have a GitHub sponsors account set up, you can add your username to `gh_sponsor` in the `_config.yml` file and it will display a link to your profile on the right of the navbar.
+
+```yaml
+gh_sponsor: chrisrhymes
+```
+
+#### Creating a Sponsors Datafile
+
+If you would like to create a page to thank your sponsors then create a data file, such as my_sponsors.yml file with the following structure:
+
+```yaml
+- tier_name: Platinum Sponsors
+  size: large
+  description: |-
+    This is the description for the Platinum Tier
+  sponsors:
+    - name: Dave McDave
+      profile: https://github.com/
+    - name: Sarah Lee-Cheesecake
+      profile: https://github.com/
+- tier_name: Gold Sponsors
+  description: |-
+    This is the description for the Gold Tier
+  sponsors:
+    - name: Dave McDave
+      profile: https://github.com/
+```
+
+The `tier_name` and `description` are required. The `size` is not required, but can be overwritten to 'large' or 'small' to increase or decrease the size of the box and the text size.
+ 
+The sponsors require a name, but not a profile link.
+
+#### Displaying the Sponsors
+
+To display the sponsors on your page, set the sponsors to the filename without the extension in the page's front matter
+
+```yaml
+layout: page
+title: My Sponsors Page
+sponsors: my_sponsors
+```
+
 ### Disqus
 
 Disqus comments are available for posts. To be able to use them, you need to set your disqus shortname in `_config.yml`. Then you need to set your Jekyll environment to production: 

data/_includes/callouts.html

@@ -8,7 +8,11 @@
                         <div class="column is-4 has-text-centered">
                             {% if callout.icon %}
                             <div class="icon is-large">
+                            {% if callout.icon_brand %}
+                                <i class="fab {{ callout.icon }} fa-4x"></i>
+                            {% else %}
                                 <i class="fas {{ callout.icon }} fa-4x"></i>
+                            {% endif %}
                             </div>
                             {% endif %}
                             <p class="title is-5">{{ callout.title }}</p>
@@ -21,7 +25,7 @@
                             {% endif %}
 
                             {% if callout.call_to_action_name %}
-                            <a href="{{ callout.call_to_action_link | prepend: site.baseurl }}" class="button is-primary">
+                            <a href="{{ callout.call_to_action_link | absolute_url }}" class="button is-primary">
                                 {{ callout.call_to_action_name }}
                             </a>
                             {% endif %}

data/_includes/footer.html

@@ -6,7 +6,7 @@
             {% for item in site.data[site.footer_menu] %}
             <div class="column has-text-centered">
                 <div>
-                    <a href="{{ item.link | prepend: site.baseurl }}" class="link">{{ item.name }}</a>
+                    <a href="{{ item.link | absolute_url }}" class="link">{{ item.name }}</a>
                 </div>
             </div>
             {% endfor %}

data/_includes/head.html

@@ -4,9 +4,12 @@
     <title>{{ page.title }} - {{ site.title }}</title>
     <link rel="stylesheet" href="{{ site.baseurl }}/assets/css/app.css">
     <link rel="shortcut icon" type="image/png"
-          {% if site.favicon %} href="{{ site.favicon | prepend: site.baseurl }}" {% else %} href="{{ site.baseurl }}/favicon.png" {% endif %}
+          {% if site.favicon %} href="{{ site.favicon | absolute_url }}" {% else %} href="{{ site.baseurl }}/favicon.png" {% endif %}
     />
-    <script defer src="https://use.fontawesome.com/releases/v5.3.1/js/all.js"></script>
+    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@fortawesome/fontawesome-free@5/css/all.min.css">
+    {% unless site.hide_share_buttons %}
+        <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bulma-social@1/bin/bulma-social.min.css">
+    {% endunless %}
     {% seo %}
     {%- if site.google_analytics -%}
       {%- include google-analytics.html -%}

data/_includes/header.html

@@ -18,19 +18,29 @@
                 {% for item in site.data.navigation %}
                     {% if item.dropdown %}
                     <div class="navbar-item has-dropdown is-hoverable">
-                        <a href="{{ item.link | prepend: site.baseurl }}" class="navbar-link {% if item.link == page.url %}is-active{% endif %}">{{ item.name }}</a>
+                        <a href="{{ item.link | absolute_url }}" class="navbar-link {% if item.link == page.url %}is-active{% endif %}">{{ item.name }}</a>
                         <div class="navbar-dropdown">
                             {% for subitem in item.dropdown %}
-                            <a href="{{ subitem.link | prepend: site.baseurl }}" class="navbar-item {% if subitem.link == page.url %}is-active{% endif %}">{{ subitem.name }}</a>
+                            <a href="{{ subitem.link | absolute_url }}" class="navbar-item {% if subitem.link == page.url %}is-active{% endif %}">{{ subitem.name }}</a>
                             {% endfor %}
                         </div>
                     </div>
                     {% else %}
-                    <a href="{{ item.link | prepend: site.baseurl }}" class="navbar-item {% if item.link == page.url %}is-active{% endif %}">{{ item.name }}</a>
+                    <a href="{{ item.link | absolute_url }}" class="navbar-item {% if item.link == page.url %}is-active{% endif %}">{{ item.name }}</a>
                     {% endif %}
                 {% endfor %}
                 {% endif %}
             </div>
+
+            <div class="navbar-end">
+                {% if site.gh_sponsor %}
+                <a class="navbar-item" href="https://github.com/sponsors/{{ site.gh_sponsor }}">
+                    <span class="icon gh-sponsor"><i class="fas fa-heart"></i></span>
+                    <span>Sponsor</span>
+                </a>
+                {% endif %}
+            </div>
+
         </div>
     </div>
 </nav>

data/_includes/hero.html

@@ -1,10 +1,10 @@
 <section class="hero {% if page.hero_height %} {{ page.hero_height }} {% else %} is-medium {% endif %} is-bold is-primary" {% if page.hero_image %} style="background: url('{{ page.hero_image }}') no-repeat center center; background-size: cover;" {% endif %}>
-    <div class="hero-body">
+    <div class="hero-body {% if page.hero_darken %} hero-darken {% endif %}">
         <div class="container">
-            <p class="title is-2">{{ page.title }}</p>
+            <h1 class="title is-2">{{ page.title }}</h1>
             <p class="subtitle is-3">{{ page.subtitle }}</p>
             {% if page.hero_link %}
-                <a href="{{ page.hero_link | prepend: site.baseurl  }}" class="button is-info is-large">{{ page.hero_link_text }}</a>
+                <a href="{{ page.hero_link | absolute_url }}" class="button is-info is-large">{{ page.hero_link_text }}</a>
             {% endif %}
         </div>
     </div>

data/_includes/menubar.html

@@ -6,11 +6,11 @@
     <ul class="menu-list">
         {% for item in menu.items %}
         <li>
-            <a href="{{ item.link | prepend: site.baseurl }}" class="{% if item.link == page.url %}is-active{% endif %}">{{ item.name }}</a>
+            <a href="{{ item.link | absolute_url }}" class="{% if item.link == page.url %}is-active{% endif %}">{{ item.name }}</a>
             {% if item.items %}
             <ul>
                 {% for subitem in item.items %}
-                <li><a href="{{ subitem.link | prepend: site.baseurl }}" class="{% if subitem.link == page.url %}is-active{% endif %}">{{ subitem.name }}</a></li>
+                <li><a href="{{ subitem.link | absolute_url }}" class="{% if subitem.link == page.url %}is-active{% endif %}">{{ subitem.name }}</a></li>
                 {% endfor %}
             </ul>
             {% endif %}

data/_includes/pagination.html

@@ -14,10 +14,10 @@
         {% if page == paginator.page %}
         <li><a class="pagination-link is-current">{{ page }}</a></li>
         {% elsif page == 1 %}
-        <li><a href="{{ paginator.previous_page_path | prepend: site.baseurl | replace: '//', '/' }}" class="pagination-link">{{ page }}</a></li>
+        <li><a href="{{ site.paginate_path | prepend: site.baseurl | replace: '//', '/' | split: '/' | pop | join: '/' }}" class="pagination-link">{{ page }}</a></li>
         {% else %}
         <li><a href="{{ site.paginate_path | prepend: site.baseurl | replace: '//', '/' | replace: ':num', page }}" class="pagination-link">{{ page }}</a></li>
         {% endif %}
         {% endfor %}
     </ul>
-</nav>
+</nav>

data/_includes/share-buttons.html

@@ -0,0 +1,19 @@
+<p><strong>Share</strong></p>
+<div class="buttons {% if include.centered %} is-centered {% endif %}">
+    <a class="button is-medium is-facebook"
+       onclick="window.open('https://www.facebook.com/share.php?u={{ site.url }}{{ page.url | prepend: site.baseurl }}');">
+        <span class="icon"><i class="fab fa-facebook fa-lg"></i></span>
+    </a>
+    <a class="button is-medium is-twitter"
+       onclick="window.open('https://twitter.com/intent/tweet?text={{ site.url }}{{ page.url | prepend: site.baseurl }}');">
+        <span class="icon"><i class="fab fa-twitter fa-lg"></i></span>
+    </a>
+    <a class="button is-medium is-linkedin"
+       onclick="window.open('https://www.linkedin.com/shareArticle?mini=true&url={{ site.url }}{{ page.url | prepend: site.baseurl }}&title={{ page.title | url_encode }}&summary=&source=');">
+        <span class="icon"><i class="fab fa-linkedin fa-lg"></i></span>
+    </a>
+    <a class="button is-medium is-reddit"
+       onclick="window.open('https://reddit.com/submit?url={{ site.url }}{{ page.url | prepend: site.baseurl }}');">
+        <span class="icon"><i class="fab fa-reddit fa-lg"></i></span>
+    </a>
+</div>

data/_includes/showcase.html

@@ -8,7 +8,7 @@
     {% for item in showcase.items %}
         <section class="showcase">
             <figure class="image {% if item.image_ratio %} {{ item.image_ratio }} {% else %} is-16by9 {% endif %}">
-                <img src="{{ item.image | prepend: site.baseurl }}" />
+                <img src="{{ item.image | absolute_url }}" />
             </figure>
             <div class="showcase-content">
                 <div class="columns is-centered">

data/_includes/sponsors.html

@@ -0,0 +1,42 @@
+{% if page.sponsors %}
+{% assign tiers=site.data.[page.sponsors] %}
+    <div class="columns is-multiline">
+        {% for tier in tiers %}
+        <div class="column is-12">
+            <p class="title is-3 has-text-centered">
+                <span>{{ tier.tier_name }}</span>
+            </p>
+            <p class="subtitle has-text-centered">
+                <span class="icon is-large gh-sponsor"><i class="fas fa-heart fa-2x"></i></span>
+            </p>
+            <div class="columns is-centered">
+                <div class="column is-6 content has-text-centered">
+                    <p>{{ tier.description | markdownify }}</p>
+                </div>
+            </div>
+
+            <div class="columns is-multiline is-centered">
+                {% for sponsor in tier.sponsors %}
+                <div class="column {% if tier.size == 'large' %} is-4-desktop is-6-tablet {% else %} is-3-desktop is-4-tablet {% endif %}">
+                    <div class="box has-text-centered">
+                        <p class="title {% if tier.size == 'large' %} is-4 {% elsif tier.size == 'small' %} is-6 {% else %} is-5 {% endif %}">
+                            {{ sponsor.name }}
+                        </p>
+                        <p class="subtitle is-6">
+                            {% if sponsor.profile %}
+                            <a href="{{ sponsor.profile }}" class="is-link is-small">View Profile</a>
+                            {% else %}
+                            &nbsp;
+                            {% endif %}
+                        </p>
+                    </div>
+                </div>
+                {% endfor %}
+            </div>
+        </div>
+        <div class="column is-12">
+            <hr />
+        </div>
+        {% endfor %}
+    </div>
+{% endif %}

data/_includes/tabs.html

@@ -5,7 +5,7 @@
     <ul>
     {% for tab in tabs.items %}
         <li {% if tab.link == page.url %} class="is-active" {% endif %}>
-            <a href="{{ tab.link | prepend: site.baseurl }}">
+            <a href="{{ tab.link | absolute_url }}">
                 {% if tab.icon %}
                 <span class="icon is-small"><i class="fas {{ tab.icon }}" aria-hidden="true"></i></span>
                 {% endif %}

data/_layouts/default.html

@@ -25,6 +25,7 @@
                 <div class="column {{ content_width }}">
                     {% include tabs.html %}
                     {% include showcase.html %}
+                    {% include sponsors.html %}
                     {{ content }}
                 </div>
                 {% if site.posts and page.show_sidebar %}

data/_layouts/post.html

@@ -15,6 +15,10 @@ layout: default
     {% endfor %}
 </div>
 
+{% unless site.hide_share_buttons %}
+{% include share-buttons.html %}
+{% endunless %}
+
 {% if site.disqus.shortname %}
   {% include disqus.html %}
 {% endif %}

data/_layouts/product-category.html

@@ -14,7 +14,7 @@ show_sidebar: false
   {% for product in sorted_products %}
   <div class="column is-4-desktop is-6-tablet">
 
-    <a href="{{ product.url | prepend: site.baseurl }}">
+    <a href="{{ product.url | absolute_url }}">
 
       <div class="card">
 

data/_posts/2019-02-09-getting-started-with-bulma-clean-theme.markdown

@@ -135,10 +135,10 @@ And then push up your changes to Github as normal.
 
 There seems to be an issue where Jekyll doesn't work locally with remote_theme, so when working locally you have to add theme back in, but remember to comment theme out again before pushing back up to GitHub or you will probably get a build warning email.
 
-## I hope your not feeling overwhelmed
+## I hope you're not feeling overwhelmed
 
 It may seem like there is a lot to do to get started, but really it shouldn't take very long to get a site up and running. All the options are there just in case you want to further customise the theme to be more personal to you, but you can just use the basic minimal settings to get yourself up and running. 
 
 ## Feedback and Issues
 
-If you have any feedback, ideas or issues with how the theme could be improved, then please create an issue on the theme's GitHub page and I will try and take a look into it as soon as I can. The theme is still quite new and I have quite a few ideas for future enhancements, so I will write a new blog post on this site when any new features become available. 
+If you have any feedback, ideas or issues with how the theme could be improved, then please create an issue on the theme's GitHub page and I will try and take a look into it as soon as I can. The theme is still quite new and I have quite a few ideas for future enhancements, so I will write a new blog post on this site when any new features become available. 

data/_posts/2020-05-08-creating-a-docs-site-with-bulma-clean-theme.markdown

@@ -0,0 +1,96 @@
+---
+layout: post
+title: Creating a docs site with Bulma Clean Theme
+description: How to create a docs site for your project with Bulma Clean Theme 
+date: 2020-05-08 09:00:07
+hero_image: https://www.csrhymes.com/img/example-docs-page.jpg
+hero_height: is-large
+hero_darken: true
+image: https://www.csrhymes.com/img/example-docs-page.jpg
+tags: bulma-clean-theme jekyll docs
+canonical_url: https://www.csrhymes.com/2020/05/08/creating-a-docs-site-with-bulma-clean-theme.html
+---
+
+I created Bulma Clean Theme as a theme for my own website and decided to open source it so others could use it as well. One of the key things I wanted to do was to create a theme that worked with GitHub Pages, which also means that you can also use it as a docs site for your project. 
+
+## GitHub Pages Configuration
+
+GitHub pages allows you to create a website for your project with free hosting. Go to your repo on GitHub, then click Settings, then scroll down to the GitHub Pages section. You have the option to create a site from the root of your master branch of from the /docs directory in your master branch. For this example, we are going to use the /docs directory. 
+
+Don't change this setting just yet as if you don't have a docs directory there will be nothing there to publish. 
+
+## Creating the docs directory
+
+Clone your git repo to a local directory, let's say `~/code/my-project` for this example. The below assumes you don't yet have a docs directory and you have [jekyll installed](https://jekyllrb.com/docs/installation/). If you do already have a docs directory you will have to rename it to something else. 
+
+Create a new jekyll installation in the docs directory, ensuring you replace your username and project name in the below example.
+
+```bash
+git clone https://github.com/username/my-project.git ~/code/my-project
+cd ~/code/my-project
+jekyll new docs
+```
+
+You should now have a base install of Jekyll in your freshly created docs directory. 
+
+## Configuring the theme
+
+1. Replace everything in the Gemfile with the following
+```
+source 'https://rubygems.org'
+gem "bulma-clean-theme",  '0.7.2'
+gem 'github-pages', group: :jekyll_plugins
+```
+
+2. Open the `_config.yml` and comment out or delete the line `theme: minima` and replace it with `remote_theme: chrisrhymes/bulma-clean-theme`, then add `github-pages` to the list of plugins. Update the baseurl to your GitHub repo name, in this example we are using `my-project` as the repo name
+```yaml
+#theme: minima
+remote_theme: chrisrhymes/bulma-clean-theme
+baseurl: "/my-project"
+plugins:
+- github-pages
+```
+
+3. Open the `index.md` file and update the front matter so the layout is page and then add a title
+```yaml
+layout: page
+title: Docs for My Project
+```
+
+4. Run `bundle install` and then `bundle exec jekyll serve`
+
+5. Visit `http://localhost:4000/my-project/` to view your new docs page.
+
+## Menu
+
+To create a menu on the left on your docs page you need to create a new yaml file in _data directory, such as `menu.yaml` and then use the below format, where the label will be the menu title and the items are the menu items. Each menu item can have a list of sub menu items if needed.
+
+```yaml
+- label: Example Menu
+  items:
+    - name: Menu item
+      link: /link/
+      items:
+        - name: Sub menu item 
+          link: /sub-menu-item/
+```
+
+## Table of contents
+
+If you would like auto generated table of contents for your docs page then add `toc: true` to the page's front matter. The table of contents works for markdown pages and loops through the heading 2s and heading 3s in the markdown and then auto generates the contents.
+
+## GitHub Sponsors
+
+If you want to link to your GitHub sponsors profile then add `gh_sponsor` with your username to the `_config.yml` file.
+
+```
+gh_sponsor: chrisrhymes
+```
+
+## Making the docs page live
+
+Once you have finished creating your docs page you can commit your changes and push everything up to GitHub. Go back to the GitHub settings page and scroll back down to the GitHub Pages section. Now we can update the setting to use the Master branch /docs folder and then GitHub will build your new docs page. 
+
+## Want to see an example?
+
+I recently updated one of my own packages to use Bulma Clean Theme to power the docs page. Check out the docs for [Bulma Block List](https://www.csrhymes.com/bulma-block-list) as an example.