jekyll-theme-open-project 2.1.10 → 2.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32130c0a3b12cf1e389be7d2d453f88f2f84d5936fd68e24714f7889dfca49f5
-  data.tar.gz: 3e882c476741d5f698e79aff328db7385a5bbd525ad1ace70e028ef2e6eca063
+  metadata.gz: be8bd9a2dab6175b3723b9fad6e3cde3657f0b8a540a696819ebae7793b057c4
+  data.tar.gz: 8015bf09f4423122785c9f3b85f69863cadb0e532f12f262c89e4e8a059fd095
 SHA512:
-  metadata.gz: 5432789a5e21986187b76b310edb3774399ef2345a24e15dd46942d4f9c921a77a57b34281e7618c8bd04bc5447c3db692a40fd42971da3ceef3d2fb0136c61f
-  data.tar.gz: 59debbfea2538ce740b37c96a58629ca7537acbcc7d70e753d5983feb42ecd363dc5cb1eb32d268cdb9d9d13a0766e1bd2d9304590d092045b5d5e55390f8f55
+  metadata.gz: e80806d51b095832bf2a6cc7f924c4a93e0eb40e80b8e17019fff6f0b0d7979d5158bf45529653fcfe1bb573478489f153b3111fb68a996b3514c422c88f5639
+  data.tar.gz: 9e5b66c811e65add28ffc5ddbf9003c4cb64546f03d70df1a5ef0883198c19a68ce454de62bbe4209b4c80ab10d6375ef0150d4ef114a230cbc581e1dccfc4f9

data/README.md

@@ -140,6 +140,33 @@ There are 3 areas to configure when you first create an Open Site, namely:
 
 ## Common setup
 
+### Git repository branch behavior
+
+You’ll see many instances of document frontmatter
+referencing Git repository URLs.
+
+Note that, wherever a `[*_]repo_url` property is encountered,
+a sibling property `[*_]repo_branch` is supported.
+(This is new in 2.1.17, until that version branch “master” was used for all repositories.)
+
+If you reference repositories that don’t use branch name “main”,
+you must either:
+
+- use a sibling `[*_]repo_branch` property to specify your custom branch name
+  (you can search for `git_repo_branch`, `repo_branch`, `github_repo_branch`
+  in this document for examples), or
+
+- specify `default_repo_branch` property in `config.yml`
+
+  (in this case, in scenarios with project sites being used in conjunction
+  with a hub site, `default_repo_branch` must be the same
+  across all project sites’ and their hub site’s `config.yml`—otherwise you’re advised
+  to use the previous option to avoid site build failure).
+
+Note that, when a referenced Git repository doesn’t contain the necessary branch
+(either explicitly specified custom branch, or `default_repo_branch`, or branch called “main”),
+this will cause build failure of that project site, or a hub site using that project site.
+
 ### Common settings
 
 (mandatory)
@@ -175,10 +202,10 @@ These settings apply to both site types (hub and project).
 
   default_repo_branch: main
   # Optional, default is `main`.
-  # Whenever a branch name isn’t specified for some repository
-  # (such as project docs or specs), this name will be used.
-  # For configuration options that contain repository settings,
-  # search `git_repo_branch`, `repo_branch`, `github_repo_branch`.
+  # Whenever branch name isn’t specified for some repository
+  # (such as project docs or specs), this name will be used
+  # during site’s build.
+  # (See branch behavior section for details.)
 
   tagline: Because examples are very important
   # Used in hero unit on main page.
@@ -201,7 +228,13 @@ These settings apply to both site types (hub and project).
   # Without this setting, one-file FA distribution, all.js, is included from free FA CDN.
 
   theme: jekyll-theme-open-project
-  permalink: /blog/:month-:day-:year/:title/
+
+  permalink: /blog/:month-:day-:year-:title/
+  # It’s important that dash-separated permalink is used for blog posts.
+  # There’re no daily or monthly blog archive pages generated.
+  # Hub sites reference posts using that method, and it’s currently non-customizable.
+  # With `collections` configuration, specify permalink for posts
+  # correctly as well (for an example, see https://github.com/metanorma/metanorma.org/blob/d2b15f6d8c4cea73d45ad899374845ec38348ff1/_config.yml#L60).
   ```
 
 ### Logo
@@ -307,12 +340,13 @@ For project posts, see below the project site section.
 
 The hub represents your company or department, links to all projects
 and offers a software and specification index.
+ 
+Note that a hub site is expected to have at least one document
+in the `projects` collection (see below).
 
 Additional items allowed/expected in _config.yml:
 
 ```yaml
-is_hub: true
-
 # Since a hub would typically represent an organization as opposed
 # to individual, this would make sense:
 seo:

data/_layouts/default.html

@@ -93,8 +93,11 @@
 
   <div class="underlay footer">
     <footer>
-      {% if site.num_all_specs > 0 or site.num_all_software > 0 %}
+      {% if site.num_all_specs > 0 or site.num_all_software > 0 or site.extra_footer_links %}
       <nav class="links" aria-label="site links">
+        {% for link in site.extra_footer_links %}
+          <a href="{{ link.url }}">{{ link.title }}</a>
+        {% endfor %}
         {% if site.num_all_software > 0 %}
           <a href="/software/">All {{ site.title }} software</a>
         {% endif %}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-open-project
 version: !ruby/object:Gem::Version
-  version: 2.1.10
+  version: 2.1.11
 platform: ruby
 authors:
 - Ribose Inc.
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-13 00:00:00.000000000 Z
+date: 2022-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -150,7 +150,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
-description:
+description: 
 email:
 - open.source@ribose.com
 executables: []
@@ -225,7 +225,7 @@ homepage: https://github.com/riboseinc/jekyll-theme-open-project/
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -240,8 +240,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: Open Project Jekyll theme
 test_files: []