jekyll-theme-open-project 1.1.8 → 1.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02cc4a622a4fd914fc625497feb31d707e1c9e7e819586fa134012422603ecbf
-  data.tar.gz: 5fac284ece99acc5ac8dfac306f99d6e8bee29dfc7767fafa879458d2cefa42e
+  metadata.gz: f0fdc3023d13e8f93e181981fd0e7b5f0e11dc4746f181c47442171947e5b4cf
+  data.tar.gz: ce7416d835cd6fa5ebfb56b9380373c72a0f63e9ed813cf696fcdd7546b61b50
 SHA512:
-  metadata.gz: ae41e0f993e045441bb2d4f108507b828b40430a87f0c92ff909a2b4419d78efd3cef5940e27b38ae87cd1e29dff486ceac54eca7e77e8f5283b64bfd6757d67
-  data.tar.gz: 374372877312deae3331a8e57a0f11e09ee3beb5118795205a4b6fc81d5b9961df82ce955ec060ac6a56d9b03c114abb3e8ab1c3b74ea59cfeb53e47e84f3d47
+  metadata.gz: a8d438c3e1123bbaaa731e786ed232d00bda45c7c3521859774903f1ae745eca7638cc51ce5470331fdbc2dee695c25c48e9f39dbec9318b1e10239725bd31a5
+  data.tar.gz: bc156aaff14c55be6d332e5263192134faf60540bbbe64de0a731970c780de46dd9e4902eb4ff19325d2ba8243df7332bd347d2bdcf21477262a247f2835f003

data/README.md

@@ -401,13 +401,19 @@ YAML frontmatter required for software:
 
 ```yaml
 repo_url: https://github.com/riboseinc/asciidoctor-rfc
+# Required.
+
 docs:
   git_repo_url: git@example.com:path/to-repo.git
   git_repo_subtree: docs
+# Docs that would be made part of open project site.
+# See the nearby section about documentation.
+
+docs_url: https://docs.rs/proj/ver/…/
+# External docs. For some links
+# like docs.rs and rubydoc, special icon and/or label will be shown.
 ```
 
-About the `docs` key in this frontmatter, see nearby section
-about documentation.
 
 ### Specification
 
@@ -424,6 +430,7 @@ ietf_datatracker_ver: "01"
 # https://datatracker.ietf.org/doc/<id>[-<version>]
 
 source_url: https://example.com/spec-source-markup
+# Required.
 ```
 
 ### Documentation for specs and software
@@ -462,9 +469,15 @@ Place the symbol in assets/symbol.svg within project directory.
 
 - Ensure SVG markup does not use IDs. It may appear multiple times
   on the page hence IDs would fail markup validation.
-- Ensure root <svg> element specifies its viewBox,
-  but no width or height attributes.
-- You can style SVG shapes using in site’s assets/css/style.scss.
+- Ensure root `<svg>` element specifies the `viewBox` attribute,
+  and no `width` or `height` attributes.
+- You can style SVG shapes by adding custom rules to site’s assets/css/style.scss.
+- Project symbols only: the same SVG is used both in hub site’s project list
+  (where it appears on white, and is expected to be colored)
+  and in project site’s top header
+  (where it appears on colored background, and is expected to be white).
+  It is recommended to use a normal color SVG, and style it in project site’s
+  custom CSS. The SVG must be created in a way that allows this to happen.
 
 
 ## Content guidelines

data/_config.yml

@@ -8,6 +8,7 @@ exclude:
   - /**/.git/*
   - /**/_*_repo/*
   - /_projects/*/assets/css/*
+  - /_projects/**/docs/*
 
 collections:
   projects:

data/_includes/home-hero.html

@@ -1,8 +1,8 @@
-<div role="presentation" class="text">
+<div class="text">
   <h1 class="title">{{ site.tagline }}</h1>
   <p class="desc">{{ site.pitch | safe }}</p>
 
-  <div class="cta" role="presentation">
+  <div class="cta">
     {% if site.is_hub %}
       <a class="button" href="{{ "/projects/" | relative_url }}">
         <i class="icon far fa-search"></i>
@@ -20,7 +20,7 @@
   </div>
 
   {% if site.parent_hub %}
-    <div class="parent-hub-plug" role="presentation">
+    <div class="parent-hub-plug">
       <span class="label">{{ site.title }} is</span>
       <a class="logo" role="presentation" href="{{ site.parent_hub.home_url }}">
         {% include parent-hub/assets/symbol.svg %}&nbsp;<span class="title">{% include parent-hub/title.html %}</span>

data/_includes/home-hub.html

@@ -2,7 +2,7 @@
 {% assign posts = site.posts_combined %}
 {% assign num_posts = site.num_posts_combined %}
 
-<div class="underlay top-background" role="presentation">
+<div class="underlay top-background">
   <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100" preserveAspectRatio="none">
     <polygon fill="white" points="0,0 100,0 100,60 0,100"/>
   </svg>
@@ -13,12 +13,12 @@
     <section class="featured-projects">
       <h2 class="title">Featured Projects</h2>
 
-      <div class="items" role="presentation">
+      <div class="items">
 
         {% for item in featured_projects limit:3 %}
           <a class="item" href="{{ item.home_url }}" role="article">
             <header>
-              <div class="logo-container" role="presentation">
+              <div class="logo-container">
                 {% assign symbol_path = item.path | split: "/" | slice: 1, 1 | join: "/" | append: "/assets/symbol.svg" %}
                 {% assign relative_symbol_path = "/projects/" | append: symbol_path %}
                 <div class="logo"><img src="{{ relative_symbol_path }}"></div>
@@ -41,10 +41,10 @@
 
   {% if num_posts > 0 %}
     <section class="featured-posts">
-      <div role="presentation" class="puny-label">Latest news</div>
+      <div class="puny-label">Latest news</div>
       <h2 class="title">From the Blog</h2>
 
-      <div class="items" role="presentation">
+      <div class="items">
         {% for item in posts limit:3 %}
           {% include post-card.html post=item %}
         {% endfor %}
@@ -61,12 +61,11 @@
 
   <h2 class="title">Other Projects</h2>
 
-  <div class="items {% if num_other_projects < 5 %}one-row{% endif %}"
-      role="presentation">
+  <div class="items {% if num_other_projects < 5 %}one-row{% endif %}">
     {% for item in other_projects %}
       <a class="item" href="{{ item.home_url }}" role="article">
         <header>
-          <div class="logo-container" role="presentation">
+          <div class="logo-container">
             {% assign symbol_path = item.path | split: "/" | slice: 1, 1 | join: "/" | append: "/assets/symbol.svg" %}
             {% assign relative_symbol_path = "/projects/" | append: symbol_path %}
             <div class="logo"><img src="{{ relative_symbol_path }}"></div>

data/_includes/home-project.html

@@ -19,7 +19,7 @@
 
 {% assign num_top_items = num_software + num_posts %}
 
-<div class="underlay top-background" role="presentation">
+<div class="underlay top-background">
   {% if num_top_items > 1 %}
     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100" preserveAspectRatio="none">
       <polygon fill="white" points="0,0 100,0 100,60 0,100"/>
@@ -33,7 +33,7 @@
       <div class="items">
         {% for item in software | limit: site.num_featured_software %}
           <a class="item" href="{{ item.url }}" role="article">
-            <div class="logo-container" role="presentation">
+            <div class="logo-container">
               {% include software-symbol.html item_id=item.id %}
             </div>
 
@@ -64,7 +64,7 @@
     <section class="featured-posts">
       <h2 class="title">From the Blog</h2>
 
-      <div class="items" role="presentation">
+      <div class="items">
         {% for item in posts | limit: site.num_featured_posts %}
           {% include post-card.html post=item %}
         {% endfor %}

data/_includes/index-page-hero.html

@@ -1,4 +1,4 @@
-<div role="presentation" class="text">
+<div class="text">
   <h1 class="title">{{ page.title }}</h1>
   <p class="desc">{{ page.description }}</p>
 </div>

data/_includes/item-doc-page.html

@@ -19,7 +19,7 @@
     {% if is_docs_landing == false %}
       <header class="sidebar-header">
         {% if include.item_type == 'software' %}
-          <div class="logo-container" role="presentation">
+          <div class="logo-container">
             {% include software-symbol.html item_id=page.id %}
           </div>
           <h3 class="title">
@@ -75,9 +75,9 @@
 
   <article>
     <header>
-      <div class="title" role="presentation">
+      <div class="title">
         {% if include.item_type == 'software' and page.url == product_base_url %}
-          <div class="logo-container" role="presentation">
+          <div class="logo-container">
             {% include software-symbol.html item_id=page.id %}
           </div>
         {% endif %}
@@ -85,7 +85,7 @@
         <h1 class="text">{{ page.title }}</h1>
       </div>
 
-      <div role="presentation">
+      <div>
         <h3 class="lead">{{ page.description }}</h3>
       </div>
 
@@ -96,7 +96,7 @@
       {% endif %}
     </header>
 
-    <div class="body" role="presentation">
+    <div class="body">
       {{ content }}
     </div>
 

data/_includes/item-external-links.html

@@ -30,7 +30,14 @@
               <i class="far fa-gem"></i>
             </span>
             <span class="lbl">
-              RubyDocs
+              API reference at RubyDocs
+            </span>
+          {% else if item_data.docs_url contains "docs.rs" %}
+            <span class="ico">
+              <i class="far fa-book"></i>
+            </span>
+            <span class="lbl">
+              API reference at Docs.rs
             </span>
           {% else %}
             <span class="ico">

data/_includes/nav-links.html

@@ -2,13 +2,13 @@
 {% assign contact_link = "mailto:" | append: site.contact_email %}
 
 {% if site.is_hub %}
-  {% include nav-page-link.html url="/projects/" title="Open Projects" %}
+  {% include nav-page-link.html url="/projects/" title="Projects" %}
 
   {% if site.num_all_software > 0 %}
-    {% include nav-page-link.html url="/software/" title="All software" active_for_nested=true %}
+    {% include nav-page-link.html url="/software/" title="All Software" active_for_nested=true %}
   {% endif %}
   {% if site.num_all_specs > 0 %}
-    {% include nav-page-link.html url="/specs/" title="All specifications" active_for_nested=true %}
+    {% include nav-page-link.html url="/specs/" title="All Specifications" active_for_nested=true %}
   {% endif %}
   {% if site.num_posts_combined > 0 %}
     {% include nav-page-link.html url="/blog/" title="Blog" active_for_nested=true %}

data/_includes/post-card.html

@@ -8,7 +8,7 @@
   " role="article">
 
   {% if include.post.parent_project == nil and site.is_hub == true %}
-    <div class="hub-symbol" role="presentation">
+    <div class="hub-symbol">
       {% include assets/symbol.svg %}
     </div>
   {% endif %}
@@ -18,11 +18,11 @@
       {% assign project_symbol_path = include.post.parent_project.name | append: "/assets/symbol.svg" %}
       {% assign relative_symbol_path = "/projects/" | append: project_symbol_path %}
       <div class="parent-project">
-        <div class="project-logo" role="presentation">
+        <div class="project-logo">
           <img src="{{ relative_symbol_path }}">
         </div>
         <h4 class="project-title">{{ include.post.parent_project.title }}</h4>
-        <div class="external-link-icon" role="presentation">
+        <div class="external-link-icon">
           <img src="{{ "assets/img/external-link.svg" | relative_url }}">
         </div>
       </div>

data/_includes/software-card-hub.html

@@ -11,7 +11,7 @@
 
 <a class="item" href="{{ product_home_url }}" role="article">
   {% if include.item_type == 'software' and site.is_hub != true %}
-    <div role="presentation" class="logo-container">
+    <div class="logo-container">
       {% include software-symbol.html item_id=include.item.id %}
     </div>
   {% endif %}
@@ -20,8 +20,8 @@
     {% if include.project_data != nil and include.project_name != nil %}
       {% assign project_symbol_path = include.project_name | append: "/assets/symbol.svg" %}
       {% assign relative_symbol_path = "/projects/" | append: project_symbol_path %}
-      <div class="parent-project" role="presentation">
-        <div class="project-logo" role="presentation"><img src="{{ relative_symbol_path }}"></div>
+      <div class="parent-project">
+        <div class="project-logo"><img src="{{ relative_symbol_path }}"></div>
         <h4 class="project-title">{{ include.project_data.title }}</h4>
       </div>
     {% endif %}

data/_layouts/default.html

@@ -15,7 +15,7 @@
 <body class="
     {% if num_projects > 0 %}site--hub{% else %}site--project{% endif %}
     {% if page.layout %}layout--{{ page.layout }}{% endif %}">
-  <div class="underlay header" role="presentation">
+  <div class="underlay header">
     <header>
       <h1 class="site-logo"><a href="/">{% include logo.html %}</a></h1>
       <nav class="top-menu">
@@ -42,7 +42,7 @@
     </header>
 
     {% if page.hero_include %}
-      <div class="hero" role="presentation">{% include {{ page.hero_include }} %}</div>
+      <div class="hero">{% include {{ page.hero_include }} %}</div>
     {% endif %}
   </div>
 
@@ -50,12 +50,12 @@
     {{ content }}
   </main>
 
-  <div class="underlay footer" role="presentation">
+  <div class="underlay footer">
     <footer>
       {% if site.is_hub %}
         <div class="site-logo">{% include logo.html %}</div>
       {% else %}
-        <div class="parent-hub-plug" role="presentation">
+        <div class="parent-hub-plug">
           <span class="label">{{ site.title }} is</span>
           <a class="logo" role="presentation" href="{{ site.parent_hub.home_url }}">
             {% include parent-hub/assets/symbol.svg %}&nbsp;<span class="title">{% include parent-hub/title.html %}</span>
@@ -69,21 +69,7 @@
     </footer>
   </div>
 
-  <script>
-    (function () {
-      var hamBtn = document.getElementById('hamburgerButton');
-      var hamMnu = document.getElementById('hamburgerMenu');
-      var hasOpened = false;
-
-      hamBtn.addEventListener('click', function (evt) {
-        hasOpened = hamMnu.classList.toggle('expanded');
-        if (hasOpened) {
-          hamBtn.setAttribute('aria-expanded', true);
-          hamMnu.setAttribute('aria-hidden', false);
-        }
-      });
-    }());
-  </script>
+  <script src="{{ "assets/js/menu.js" | relative_url }}"></script>
 
   {% include scripts.html %}
 </body>

data/_layouts/post.html

@@ -64,7 +64,7 @@ layout: default
     </aside>
   {% endif %}
 
-  <div class="body" role="presentation">
+  <div class="body">
     {{ content }}
   </div>
 </article>

data/_layouts/project-index.html

@@ -14,7 +14,7 @@ layout: default
           role="article">
 
         <header>
-          <div class="logo-container" role="presentation">
+          <div class="logo-container">
             {% assign symbol_path = project.path | split: "/" | slice: 1, 1 | join: "/" | append: "/assets/symbol.svg" %}
             {% assign relative_symbol_path = "/projects/" | append: symbol_path %}
             <div class="logo"><img src="{{ relative_symbol_path }}"></div>

data/_sass/open-project-header-footer.scss

@@ -152,7 +152,7 @@ body > .underlay > footer {
       > .text {
         padding-bottom: 85px;
         @media screen and (min-width: $bigscreen-breakpoint) {
-          padding-bottom: 120px;
+          padding-bottom: 100px;
         }
       }
     }

data/_sass/open-project-mixins.scss

@@ -188,13 +188,51 @@
         font-size: 20px;
       }
     }
+
     > .body {
       pre {
         overflow-x: scroll;
         overflow-y: hidden;
         line-height: 1;
-        font-size: 80%;
         white-space: pre-wrap;
+        > code {
+          font-size: 80%;
+        }
+      }
+      .sectionbody {
+
+        // Used for e.g. code listing headings and tip block labels
+        .title {
+          text-transform: uppercase;
+          font-size: 12px;
+        }
+
+        // Used for tip block labels
+        .admonitionblock {
+          .icon {
+            border-left: 1px dotted grey;
+            > .title {
+              transform: rotate(-90deg);
+            }
+          }
+          .content {
+            > div:first-child {
+              > :first-child {
+                margin-top: 0;
+              }
+            }
+            > div:last-child {
+              > :last-child {
+                margin-bottom: 0;
+              }
+              &.ulist {
+                li:last-child > :last-child {
+                  margin-bottom: 0;
+                }
+              }
+            }
+          }
+        }
       }
     }
   }
@@ -222,12 +260,15 @@
   }
 
   @media screen and (min-width: $bigscreen-breakpoint) {
-    flex-flow: row wrap;
+    flex-flow: row nowrap;
 
     > .nav-sidebar {
       flex: 1;
       flex-grow: 1;
       padding-top: 70px;
+      > section > .section-items {
+        padding-right: 40px;
+      }
     }
 
     > article {

data/assets/js/menu.js

@@ -0,0 +1,15 @@
+(function () {
+  'use strict';
+
+  var hamBtn = document.getElementById('hamburgerButton');
+  var hamMnu = document.getElementById('hamburgerMenu');
+  var hasOpened = false;
+
+  hamBtn.addEventListener('click', function (evt) {
+    hasOpened = hamMnu.classList.toggle('expanded');
+    if (hasOpened) {
+      hamBtn.setAttribute('aria-expanded', true);
+      hamMnu.setAttribute('aria-hidden', false);
+    }
+  });
+}());

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-open-project
 version: !ruby/object:Gem::Version
-  version: 1.1.8
+  version: 1.1.9
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-20 00:00:00.000000000 Z
+date: 2018-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -203,6 +203,7 @@ files:
 - assets/fa/fa-solid.js
 - assets/fa/fontawesome.js
 - assets/img/external-link.svg
+- assets/js/menu.js
 homepage: https://github.com/riboseinc/jekyll-theme-open-project/
 licenses:
 - MIT