jekyll-theme-open-project 1.1.22 → 1.1.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7b32212dcad5f501fa4f6ebf677abc5b1617f265
-  data.tar.gz: d07256ea4108273acd9671565d008d585dc4e8fd
+SHA256:
+  metadata.gz: 743ef6f6997140f43beb6d9735795c56fee28d897bcb80e081f10a5921625d36
+  data.tar.gz: bdd6142500f0b231311451a231c1cbd89a40d63288d1a20a603a20e38d2e975b
 SHA512:
-  metadata.gz: 20b7a7c6054966854a1a65cd67fc5803dc1ef6c88eb135bcf499e296a82e5d93f423cbb5b009cccffb92f4c5df61e5893340567d15cfe7a9a2b3e31d8d5a9a58
-  data.tar.gz: a833f8ef9b4fa07d493bbfac3e518da679b8a08198a7aa7be44a3358e51f4e9a6c68d08b232e591a0ca018d23c8d244e0af0f82afac5caf1a7c6dd96236ad676
+  metadata.gz: 733f3a2dcc8e506dc07d8c7830e91b57ba06417554edcd11e77158e9a59fca3a900ca91597bc4e55bced039f119feee23ab05a763b71ebafb0608f2da4a70ada
+  data.tar.gz: bfd487f407634ee6bddafe018256d1f0f61dd8a4b81d51c1809f87237637d82d4e7dfc536fb149532c86fff0813753cc49c31da9359022567daa5ecbdc2f87bd

data/README.md

@@ -45,6 +45,10 @@ and it hasn’t been tested on newer versions.
 
     jekyll new my-open-site
 
+If you use Git for site source version management,
+see the “Extra .gitignore rules” section below
+for additional lines you should add to your `.gitignore`.
+
 ### Installing theme
 
 Add this line to your Jekyll site's `Gemfile`,
@@ -63,6 +67,7 @@ Also in the `Gemfile`, add two important plugins to the `:jekyll_plugins` group.
 group :jekyll_plugins do
   gem "jekyll-seo-tag"
   gem "jekyll-data"
+  gem "jekyll-asciidoc"
   gem "jekyll-theme-open-project-helpers"
   # ...other plugins, if you use any
 end
@@ -105,6 +110,10 @@ These settings apply to both site types (hub and project).
   (and don’t forget to remove default theme requirement there):
 
   ```yaml
+  url: https://example.com/
+  # Site’s URL with protocol and without optional www. prefix.
+  # Used e.g. for marking external links in docs and blog posts.
+
   title: Site title
   description: Site description
   # The above two are used by jekyll-seo-tag for things such as
@@ -328,6 +337,11 @@ author: "Company or Individual Name Goes Here"
 parent_hub:
   git_repo_url: git@example.com:path/to-repo.git
   home_url: https://www.example.com/
+
+algolia_search:
+  api_key: '<your Algolia API key>'
+  index_name: '<your Algolia index name>'
+# Only add this if you want to use Algolia’s search on your project site.
 ```
 
 File layout is the same as described in the section
@@ -511,6 +525,7 @@ and then in `<theme root>/_includes/<include_name>`. Consequently,
 you put your include overrides directly in site root, **not** inside
 `_includes/` directory of your side.
 
+
 ## Theme layouts
 
 Normally you don’t need to specify layouts manually, except where
@@ -624,6 +639,21 @@ $hub-specs--hero-background: $hub-specs--primary-dark-color !default;
 ```
 
 
+## Extra .gitignore rules
+
+Add these lines to your .gitignore to prevent
+theme-generated files and directories from adding chaos to your Git staging.
+
+```
+_software/*/.git
+_software/*/docs
+_software/_*_repo
+_specs/*/.git
+_specs/*/docs
+parent-hub/*
+```
+
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub

data/_config.yml

@@ -4,6 +4,12 @@ includes_dir: .
 
 permalink: /blog/:month-:day-:year/:title/
 
+# algolia_search:
+#   api_key: ''
+#   index_name: ''
+# Uncomment this if you want to use Algolia’s search.
+# It’s free for open-source projects.
+
 exclude:
   - /**/.git/*
   - /_projects/**/_*_repo/*

data/_includes/item-doc-page.html

@@ -29,7 +29,7 @@
       </header>
 
       <section class="external-links">
-        {% include item-external-links.html item_type=include.item_type item_data=include.item_data %}
+        {% include item-external-links.html item_type=include.item_type item_data=item_data %}
       </section>
 
     {% elsif num_nav_sections > 0 %}
@@ -60,8 +60,8 @@
                     {{ linked_page.title }}
                   </span>
               {% else %}
-                <li class="item disabled">
-                  <span>
+                <li class="item">
+                  <span class="tbd">
                     {{ item }}
                   </span>
               {% endif %}
@@ -85,13 +85,20 @@
         <h1 class="text">{{ page.title }}</h1>
       </div>
 
+      {% if is_docs_landing == false %}
+        <nav>
+          <button class="docs-nav-toggle">Show table of contents</button>
+          <a href="{{ item_data.docs.git_repo_url }}/edit/master/docs/{{ page.path | split: "/" | last }}" class="docs-suggest-edits">Suggest edits to this page</a>
+        </nav>
+      {% endif %}
+
       <div>
         <h3 class="lead">{{ page.description }}</h3>
       </div>
 
       {% if is_docs_landing %}
         <div class="external-links">
-          {% include item-external-links.html item_type=include.item_type item_data=include.item_data %}
+          {% include item-external-links.html item_type=include.item_type item_data=item_data %}
         </div>
       {% endif %}
     </header>
@@ -100,5 +107,14 @@
       {{ content }}
     </div>
 
+    {% if is_docs_landing == false %}
+    <footer>
+      <nav>
+        <button class="docs-nav-toggle">Show table of contents</button>
+        <a href="{{ item_data.docs.git_repo_url }}/edit/master/docs/{{ page.path | split: "/" | last }}" class="docs-suggest-edits">Suggest edits to this page</a>
+      </nav>
+    </footer>
+    {% endif %}
+
   </article>
 </section>

data/_includes/item-external-links.html

@@ -18,9 +18,6 @@
               Source Repository
             </span>
           {% endif %}
-          <span class="ico-ext">
-            <i class="fas fa-external-link-square-alt"></i>
-          </span>
         </a> {% endif %}
     {% if item_data.docs_url %}
       <li class="item">
@@ -47,9 +44,6 @@
               Documentation
             </span>
           {% endif %}
-          <span class="ico-ext">
-            <i class="fas fa-external-link-square-alt"></i>
-          </span>
         </a> {% endif %}
   </ul>
 {% else if include.item_type == 'specs' and item_data.rfc_id or item_data.ietf_datatracker_id or item_data.source_url %}
@@ -60,9 +54,6 @@
           <span class="lbl">
             IETF RFC {{ item_data.rfc_id }}
           </span>
-          <span class="ico-ext">
-            <i class="fas fa-external-link-square-alt"></i>
-          </span>
         </a> {% endif %}
     {% if item_data.ietf_datatracker_id %}
       <li class="item">
@@ -70,9 +61,6 @@
           <span class="lbl">
             IETF document
           </span>
-          <span class="ico-ext">
-            <i class="fas fa-external-link-square-alt"></i>
-          </span>
         </a> {% endif %}
     {% if item_data.source_url %}
       <li class="item">
@@ -92,9 +80,6 @@
               Source Markup
             </span>
           {% endif %}
-          <span class="ico-ext">
-            <i class="fas fa-external-link-square-alt"></i>
-          </span>
         </a> {% endif %}
   </ul>
 {% endif %}

data/_includes/nav-links.html

@@ -15,6 +15,13 @@
   {% endif %}
 
 {% else %}
+
+  {% if site.algolia_search %}
+    <div class="search-widget">
+      <input type="search" id="siteSearchInput" placeholder="Type to search…">
+    </div>
+  {% endif %}
+
   {% if site.num_all_software > 0 %}
     {% include nav-page-link.html url="/software/" title="Software ecosystem" active_for_nested=true %}
   {% endif %}
@@ -28,5 +35,7 @@
     {% include nav-page-link.html url="/blog/" title="Blog" active_for_nested=true %}
   {% endif %}
 
-  {% include nav-page-link.html url=contact_link title="Contact" %}
+  {% if site.algolia_search %}
+    <a href="javascript: void 0;" class="search"><i class="fas fa-search"></i></a>
+  {% endif %}
 {% endif %}

data/_layouts/default.html

@@ -11,6 +11,10 @@
   <link id="themeCSS" rel="stylesheet" href="{{ "assets/css/style.css" | relative_url }}">
   <script defer src="https://pro.fontawesome.com/releases/v5.1.0/js/all.js" integrity="sha384-E5SpgaZcbSJx0Iabb3Jr2AfTRiFnrdOw1mhO19DzzrT9L+wCpDyHUG2q07aQdO6E" crossorigin="anonymous"></script>
 
+  {% if site.is_hub == false and site.algolia_search %}
+    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css">
+  {% endif %}
+
   {% seo %}
 </head>
 
@@ -36,10 +40,6 @@
           <h1 class="site-logo"><a href="/">{% include logo.html %}</a></h1>
         </div>
 
-        <nav>
-          {% include nav-links.html %}
-        </nav>
-
         {% include social-links.html %}
       </div>
     </header>
@@ -72,6 +72,25 @@
     </footer>
   </div>
 
+  {% if site.is_hub == false and site.algolia_search %}
+    <script src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"></script>
+
+    {% comment %}
+    This would break a strict CSP, but Jekyll refuses to Liquid-process JS files
+    without also adding HTML wrapping. Eek.
+    {% endcomment %}
+    <script>
+      window.initAlgolia = function () {
+        docsearch({ 
+          apiKey: '{{ site.algolia_search.api_key }}', 
+          indexName: '{{ site.algolia_search.index_name }}', 
+          inputSelector: 'input[type=search]', 
+          debug: false,
+        }); 
+      };
+    </script> 
+  {% endif %}
+
   <script src="{{ "assets/js/headroom.min.js" | relative_url }}"></script>
   <script src="{{ "assets/js/opf.js" | relative_url }}"></script>
 

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

@@ -173,7 +173,8 @@ body > .underlay.footer {
 body > .underlay > header {
   padding-top: 26px;
   padding-bottom: 26px;
-  z-index: 2;
+  z-index: 5;
+  // Higher than hero, otherwise Algolia search pop-up might have stuff over it
 
   align-items: flex-start;
   flex-flow: row nowrap;
@@ -216,10 +217,10 @@ body > .underlay > header {
 
     > nav,
     > .social-links {
-      span, a {
+      a {
         &:link, &:visited, &:hover {
-          color: white;
           font-size: 1.3em;
+          color: white;
         }
       }
     }
@@ -228,11 +229,21 @@ body > .underlay > header {
       flex: 1;
       display: flex;
       flex-flow: column nowrap;
-      align-items: center;
-      justify-content: center;
+      align-items: flex-start;
+      justify-content: flex-start;
+      align-self: stretch;
+
+      a.search {
+        display: none;
+      }
+      .search-widget {
+        margin-top: 2em;
+        margin-bottom: 1em;
+      }
 
       > * {
         margin: .25em;
+        margin-left: 2em;
       }
       > .active {
         font-weight: bold;
@@ -249,16 +260,46 @@ body > .underlay > header {
     }
   }
 
+  > .top-menu > .search-widget,
+  > .hamburger-menu > nav > .search-widget {
+    input[type=search] {
+      padding: 6px 10px 6px 10px;
+      border-radius: 1em;
+      font-size: inherit;
+      line-height: inherit;
+      border: 0;
+      background-color: white;
+    }
+  }
+
   > .top-menu {
     flex: 1;
 
-    > * {
+    > :not(.search-widget) {
       display: inline-block;
       font-weight: 600;
       margin-right: 20px;
       padding: 6px 10px 6px 10px;
       white-space: nowrap;
     }
+    > .search-widget {
+      width: 0;
+      display: none;
+      position: relative;
+
+      > * {
+        flex: 1;
+      }
+    }
+    &.with-expanded-search {
+      > a {
+        display: none;
+      }
+      > .search-widget {
+        width: 90%;
+        display: inline-flex;
+      }
+    }
   }
 
   > .top-menu,

data/_sass/open-project-mixins.scss

@@ -1,6 +1,4 @@
 @mixin tbd($color: red) {
-  // TODO: Refactor disabled item doc navigation links with this mixin in mind
-
   position: relative;
   padding: 0 .3em;
   border: 1px dashed lighten($main-font-color, 70);
@@ -234,6 +232,46 @@
 
   > .docs-nav {
     padding-top: 50px;
+    background: transparent;
+
+    &.top-expandable {
+      border-bottom: 1px solid silver;
+      z-index: 4;
+
+      position: fixed;
+      left: 0;
+      right: 0;
+
+      padding-top: 0;
+      padding-left: 2em;
+      padding-right: 2em;
+
+      transition:
+        background 200ms cubic-bezier(0.23, 1, 0.32, 1),
+        transform 200ms linear;
+
+      overflow: hidden;
+
+      .sidebar-header {
+        background: white;
+        cursor: pointer;
+        padding-top: 10px;
+        padding-bottom: 10px;
+      }
+
+      &.expanded {
+        box-shadow: 0px -10px 30px 0 rgba(black, 0.8);
+        z-index: 6;
+        overflow-y: scroll;
+        background: white;
+        border-bottom: none;
+      }
+    }
+
+    &.pinned {
+      z-index: 4;
+      transform: translateY(0);
+    }
 
     > .sidebar-header, > section {
       margin-bottom: 15px;
@@ -281,22 +319,6 @@
           font-size: 15px;
           font-weight: normal;
 
-          &.disabled {
-            span {
-              $disabled-label-width: 50px;
-              opacity: 0.5;
-              position: relative;
-
-              &:before {
-                opacity: 0.4;
-                position: absolute;
-                width: $disabled-label-width;
-                left: -$disabled-label-width;;
-                content: "TBD";
-                font-weight: bold;
-              }
-            }
-          }
           &.selected {
             span {
               font-weight: bold;
@@ -316,6 +338,46 @@
     background: white;
     z-index: 1;
 
+    > header > nav,
+    > footer > nav {
+      line-height: 1;
+
+      button, a {
+        border: 0;
+        padding: 0;
+        margin-right: 1em;
+
+        font-family: inherit;
+        font-size: 80%;
+        font-weight: bold;
+
+        background: white;
+        color: $primary-dark-color;
+        cursor: pointer;
+
+        text-decoration: none;
+
+        &:last-child {
+          margin-right: 0;
+        }
+
+        .ico-ext {
+          margin-left: .5em;
+        }
+      }
+    }
+
+    > header > nav {
+      margin-top: -2em;
+    }
+
+    > footer > nav {
+      margin-top: 2em;
+      @media screen and (min-width: $bigscreen-breakpoint) {
+        margin-left: 2em;
+      }
+    }
+
     > header {
       > .title {
         @media screen and (min-width: $bigscreen-breakpoint) {
@@ -372,7 +434,7 @@
     }
 
     > article {
-      max-width: none;
+      max-width: none;  // Overrides .main-article base style
 
       > header > .title {
         border-bottom-width: 0;

data/assets/js/opf.js

@@ -6,10 +6,34 @@
 
 
 
+  /* Search box in top bar */
+
+  var initSearchWidget = function(containerEl, triggerEl, inputEl) {
+    var showSearch = function() {
+      containerEl.classList.add('with-expanded-search');
+      inputEl.focus();
+    };
+    var hideSearch = function() {
+      containerEl.classList.remove('with-expanded-search');
+    };
+    triggerEl.addEventListener('click', showSearch);
+
+    window.initAlgolia();
+  };
+
+
+
+  var topMenuEl = body.querySelector('.top-menu');
+  var triggerEl = topMenuEl.querySelector('.search');
+  var inputEl = topMenuEl.querySelector('input[type=search]');
+
+
+
   /* Topmost hamburger menu */
 
-  var initCollapsibleMenu = function(triggerEl, menuEl) {
+  var initCollapsibleMenu = function(origNavEl, triggerEl, menuEl) {
     var hasOpened = false;
+    var origNavNextSiblingEl = origNavEl.nextSibling;
 
     if (triggerEl != null && menuEl != null) {
       triggerEl.addEventListener('click', function (evt) {
@@ -17,6 +41,13 @@
         if (hasOpened) {
           triggerEl.setAttribute('aria-expanded', true);
           menuEl.setAttribute('aria-hidden', false);
+          origNavEl.classList.remove('top-menu');
+          origNavEl.remove();
+          menuEl.insertBefore(origNavEl, menuEl.querySelector('.site-logo-container').nextSibling);
+        } else {
+          origNavEl.remove();
+          origNavNextSiblingEl.parentNode.insertBefore(origNavEl, origNavNextSiblingEl);
+          origNavEl.classList.add('top-menu');
         }
       });
     }
@@ -85,27 +116,15 @@
     var docsNavH = docsNav.offsetHeight;
     var docsNavSections = docsNav.querySelectorAll('section');
 
-    // Offet represents the top header height; meaning it is offset
-    // of documentation menu from the topmost edge of viewport
-    var offset = collapsibleHeader.getHeaderHeight();
+    // Used to offset expandable documentation menu from the topmost edge of viewport
+    // to account for top header height
+    var topHeaderHeight = collapsibleHeader.getHeaderHeight();
 
     article.style.paddingTop = '2em';
+
+    docsNav.classList.add('top-expandable');
     docsNav.style.zIndex = '4';
-    docsNav.style.position = 'fixed';
-    docsNav.style.top = '' + offset + 'px';
-    docsNav.style.left = '0';
-    docsNav.style.right = '0';
-    docsNav.style.paddingTop = '0';
-    docsNav.style.paddingLeft = '2em';
-    docsNav.style.paddingRight = '2em';
-    docsNav.style.transition = 'background 200ms cubic-bezier(0.23, 1, 0.32, 1), transform 200ms linear';
-    docsNav.style.background = 'transparent';
-    docsNav.style.overflow = 'hidden';
-
-    docsNavHeader.style.background = 'white';
-    docsNavHeader.style.paddingTop = '10px';
-    docsNavHeader.style.paddingBottom = '10px';
-    docsNavHeader.style.cursor = 'pointer';
+    docsNav.style.top = '' + topHeaderHeight + 'px';
 
     docsNavHeader.innerHTML = docsNavHeader.innerHTML + ' ▼';
 
@@ -120,34 +139,27 @@
 
     var collapse = function (docsNav) {
       hasOpened = false;
-      docsNav.style.background = 'transparent';
+
+      docsNav.classList.remove('expanded');
+
       docsNavSections.forEach(function (el) {
         el.style.opacity = '0';
       });
 
       closingTransition = window.setTimeout(function () {
-        docsNav.style.overflowY = 'hidden';
         docsNav.style.height = '' + docsNavHeaderH + 'px';
         docsNav.style.bottom = 'unset';
         docsNav.scrollTop = 0;
-        docsNav.style.borderBottom = '1px solid silver';
       }, 2);
     };
     var open = function (docsNav) {
       hasOpened = true;
       window.clearTimeout(closingTransition);
 
-      docsNav.style.overflowY = 'scroll';
+      docsNav.classList.add('expanded');
       docsNav.style.height = 'auto';
+      docsNav.style.bottom = '' + 100 + 'px';
 
-      if (collapsibleHeader.isPinned()) {
-        docsNav.style.bottom = '0';
-      } else {
-        docsNav.style.bottom = '-' + offset + 'px';
-      }
-
-      docsNav.style.background = 'white';
-      docsNav.style.borderBottom = 'none';
       docsNavSections.forEach(function (el) {
         el.style.opacity = '1';
       });
@@ -173,14 +185,12 @@
         if (hasOpened) {
           this.pin();
         } else {
-          docsNav.style.transform = 'translateY(-' + offset + 'px)';
+          docsNav.style.transform = 'translateY(-' + topHeaderHeight + 'px)';
         }
       },
       onPin: function () {
-        docsNav.style.top = '' + offset + 'px';
-        docsNav.style.zIndex = '4';
+        docsNav.style.top = '' + topHeaderHeight + 'px';
         docsNav.style.transform = 'translateY(0)';
-        docsNav.style.borderBottom = '1px solid silver';
       },
     });
 
@@ -190,6 +200,7 @@
       hasOpened: function () {
         return hasOpened;
       },
+      toggle: toggle,
     }
   };
 
@@ -197,6 +208,7 @@
 
   // Initializing stuff
   var hamburgerMenu = initCollapsibleMenu(
+    document.querySelector('header nav.top-menu'),
     document.getElementById('hamburgerButton'),
     document.getElementById('hamburgerMenu'));
 
@@ -216,5 +228,13 @@
     collapsibleHeader.assignCollapsibleDocsNav(collapsibleDocsNav);
   }
 
+  var docArticleSelectorPrefix = 'body.layout--product .documentation:not(.docs-landing) > article ';
+  var docArticleHeaderNavToggle = document.querySelector(docArticleSelectorPrefix + '> header > nav > button.docs-nav-toggle');
+  var docArticleFooterNavToggle = document.querySelector(docArticleSelectorPrefix + '> footer > nav > button.docs-nav-toggle');
+  for (var el of [docArticleFooterNavToggle, docArticleHeaderNavToggle]) {
+    if (el) { el.addEventListener('click', collapsibleDocsNav.toggle); }
+  }
+
+  initSearchWidget(topMenuEl, triggerEl, inputEl);
 
 }());

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-open-project
 version: !ruby/object:Gem::Version
-  version: 1.1.22
+  version: 1.1.23
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-05 00:00:00.000000000 Z
+date: 2018-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.1.22
+        version: 1.1.23
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.1.22
+        version: 1.1.23
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -226,7 +226,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Open Project Jekyll theme