bulma-clean-theme 0.7 → 0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8d67bce7574a528187ff83f42a98c92cbddcadfb
-  data.tar.gz: 245b335b23f5d019642025070d86f115a5790672
+  metadata.gz: eb9a89330083bcaefc952d6d10120eb130aecfdf
+  data.tar.gz: 77fdd31d4dcc2e3927fe3952cce533047a195781
 SHA512:
-  metadata.gz: 5709435bc0f60ac0755de293f39027b321f991f7201081a5e275e9eb02007137fdc367b15d016aeb9cfa94f0ce70fc5089274afb4822bb7dc6cb584664a91f28
-  data.tar.gz: af4fb3b2db23b8c3e9b0e811438ffd29e4f119719e1e3dc85cf4b90d062440120238eafe248a41e6ca3a091840a73c1a78684e285c86d58adf1fa84cae7273fb
+  metadata.gz: 0dea8b7b9bca58b49deb78d8d1cc8741114783db7cd014a3f30b3cc68a31a6837bd13b652702ac4727ca2d66b8b7d7cd527417f32aa1a4769bc7a62de9afdff9
+  data.tar.gz: d095475d04419ab8e173277eb8fa179b6f121240089d5bf383bab82c8fde17e9fa35f2b4a317164005119822a7237b7ba4391316b75a6ed2c4d213f7e352dcef

data/README.md

@@ -26,6 +26,7 @@ This is a clean and simple Jekyll Theme built with the [Bulma](https://bulma.io/
     * [Favicon](#favicon)
     * [Showcases](#showcases)
     * [Sponsors](#sponsors)
+    * [Gallery](#gallery)
     * [Disqus](#disqus)
 * [Contributing](#contributing)
 * [Development](#development)
@@ -75,6 +76,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**
@@ -95,6 +99,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
 
@@ -378,7 +386,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
@@ -386,7 +394,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.
 
@@ -508,6 +517,42 @@ title: My Sponsors Page
 sponsors: my_sponsors
 ```
 
+### Gallery
+
+Display a simple image gallery on a page, with image descriptions.
+
+#### Create an image gallery data file
+
+Start by creating a gallery data file using the below format, for example `my_gallery.yml`. 
+
+```yaml
+- title: Image Gallery Title
+  images:
+    - link: https://via.placeholder.com/800x450
+      alt: The alt text for the image
+      description: |-
+        The image description can be written in **markdown** if required
+      ratio: is-16by9
+    - link: https://via.placeholder.com/800x600
+      alt: The alt text for the image
+      description: The image description
+      ratio: is-4by3
+```
+
+* If a ratio is not provided it will default to 16 by 9. Use [Bulma image](https://bulma.io/documentation/elements/image/) classes to define the image ratio required. 
+* The description can be plain text or it can be markdown if required. 
+* The alt will be used as the images alt text.
+
+#### Displaying the gallery
+
+In your pages front matter add a gallery with the datafiles filename without the extension.
+
+```yaml
+layout: page
+title: My Image Gallery
+gallery: my_gallery
+```
+
 ### 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 | relative_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 | relative_url }}" class="link">{{ item.name }}</a>
                 </div>
             </div>
             {% endfor %}

data/_includes/gallery.html

@@ -0,0 +1,27 @@
+{% if page.gallery %}
+    {% assign galleries=site.data.[page.gallery] %}
+    {% for gallery in galleries %}
+    <div class="columns is-multiline">
+        <div class="column is-12">
+            <p class="title is-3 has-text-centered">{{ gallery.title }}</p>
+        </div>
+        {% for image in gallery.images %}
+        <div class="column is-4-desktop is-6-tablet">
+            <div class="card">
+                <div class="card-image">
+                    <figure class="image {{ image.ratio | default: is-16by9 }}">
+                        <img src="{{ image.link | absolute_url }}" alt="{{ image.alt }}">
+                    </figure>
+                </div>
+                <div class="card-content">
+                    <div class="content">
+                        {{ image.description | markdownify }}
+                    </div>
+
+                </div>
+            </div>
+        </div>
+        {% endfor %}
+    </div>
+    {% endfor %}
+{% endif %}

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 | relative_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,15 +18,15 @@
                 {% 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 | relative_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 | relative_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 | relative_url }}" class="navbar-item {% if item.link == page.url %}is-active{% endif %}">{{ item.name }}</a>
                     {% endif %}
                 {% endfor %}
                 {% endif %}

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 | relative_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 | relative_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 | relative_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 | relative_url }}" />
             </figure>
             <div class="showcase-content">
                 <div class="columns is-centered">

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 | relative_url }}">
                 {% if tab.icon %}
                 <span class="icon is-small"><i class="fas {{ tab.icon }}" aria-hidden="true"></i></span>
                 {% endif %}

data/_layouts/default.html

@@ -26,6 +26,7 @@
                     {% include tabs.html %}
                     {% include showcase.html %}
                     {% include sponsors.html %}
+                    {% include gallery.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 | relative_url }}">
 
       <div class="card">
 

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. 

data/_sass/_layout.scss

@@ -16,4 +16,8 @@ div.highlight {
     box-shadow: $box-shadow;
     padding: 1.5rem;
     margin-bottom: 3rem;
+}
+
+.hero-darken {
+    background-color: rgba($hero-darken, 0.5);
 }

data/_sass/_main.scss

@@ -8,6 +8,8 @@ $tabs-link-active-color: $primary;
 $tabs-link-active-border-bottom-color: $primary;
 
 @import "../node_modules/bulma/bulma.sass";
+$hero-darken: $dark !default;
+
 @import "layout";
 @import "syntax";
 @import "showcase";

data/node_modules/bulma-block-list/README.md

@@ -17,4 +17,16 @@ A simple scss package extending Bulma with block style list elements
 </ul>
 ```
 
+## List Item Overrides
+
+In v0.3 you can override the list item styles.
+
+```html
+<ul class="block-list is-small">
+    <li>Item one</li>
+    <li class="is-primary is-outlined is-large">Item two</li>
+    <li>Item three</li>
+</ul>
+```
+
 For examples see [csrhymes.com/bulma-block-list](https://www.csrhymes.com/bulma-block-list)

data/node_modules/bulma-block-list/docs/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+gem "bulma-clean-theme",  '0.8'
+gem 'github-pages', group: :jekyll_plugins