jekyll-theme-open-project 1.1.25 → 1.1.26

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e09f5fa2c2fd4362589ab6084c27892a7a9074a4bca12cf5eee38724552891da
-  data.tar.gz: 01de902102f9fdf21af5c09b0622825b813cdb4a3c5625ac8ee18d8cba58f369
+  metadata.gz: f54c864f92c1990c16c57ba81232c3656ca564c42d361031d3c9b0856c3da8ef
+  data.tar.gz: afa0d424a4a9dddbd6d5084918724adc2a2d93fbb9982d48dd85855d0d06d41f
 SHA512:
-  metadata.gz: faf6286e377c24a56a813e202dbf31fb423f97a446123c35aa75721eeb7fb7c3b00cf427b8891dabb60cc9b27956713d45f871017c89584cd340da8d3cecb5bd
-  data.tar.gz: c92a53183417eaa8496cf4c0cdaee5d7fc9d8dfe85082b1778414c3958bf2e6f9f64d38812950fa2be9420509a67ffe9e38d9249d08a707103eff23bdb7dec28
+  metadata.gz: 9d2b238dc44d3e0169c9a7b15515c2b4bcb8a71b2fe71ec19bd3aa2025a157833511ece3997448091776e5e852cf2b2314e4ee0a18f52ba7ce47789f186f47b0
+  data.tar.gz: 540c37e4228591bc114c575c49b333ca3b38e9542eb51bd84f1c0e7a790bb1a1e0395e77ea0d01f99679f8dea826545b3c15d2398ec54c1b9da57bf7c54ffe0a

data/README.md

@@ -449,6 +449,31 @@ docs_url: https://docs.rs/proj/ver/…/
 # like docs.rs and rubydoc, special icon and/or label will be shown.
 ```
 
+#### Displaying software docs
+
+Inside the repository and optionally subtree specified under `docs`
+in above sample, place a file called `navigation.md` containing
+only frontmatter, following this sample:
+
+```yaml
+sections:
+- name: Introduction
+  items:
+    - overview
+    - installation
+- name: Usage
+  items:
+    - basic
+```
+
+In the same directory, place the required document pages—in this case, `overview.md`,
+`installation.md`, and `basic.md`. Each document page is required to contain
+standard YAML frontmatter with at least `title` specified.
+
+During project site build, Jekyll pulls docs for software that’s part of the
+site and builds them, converting pages from Markdown/AsciiDoc to HTML and adding
+the navigation.
+
 
 ### Specification
 
@@ -466,35 +491,10 @@ ietf_datatracker_ver: "01"
 
 source_url: https://example.com/spec-source-markup
 # Required.
-```
 
-### Documentation for software, and specification contents
 
-**Software docs** should be kept in software
-package’s own repository, under a directory such as `docs/`.
-Inside that directory, place a file called `navigation.md` containing
-only frontmatter, in format like this:
+# For displaying spec contents, see below:
 
-```yaml
-sections:
-- name: Introduction
-  items:
-    - overview
-    - installation
-- name: Usage
-  items:
-    - basic
-```
-
-In the same directory, place the required document pages—in this case, `overview.md`,
-`installation.md`, and `basic.md`. Each document page is required to contain
-standard YAML frontmatter with at least `title` specified.
-
-For **specification contents** to be built, provide configuration
-and navigation in YAML frontmatter of corresponding `_specs/<specname>.adoc` file,
-following this example:
-
-```yaml
 spec_source:
   git_repo_url: https://github.com/<user>/<repo>
   git_repo_subtree: images
@@ -511,12 +511,24 @@ navigation:
       ignore_missing: yes
 ```
 
+#### Displaying specification contents
+
+While software doc pages are currently simply generated using standard
+Jekyll means from Markdown/AsciiDoc into HTML,
+building specs is handled in a more flexible way,
+delegating the source -> Open Project site-compatible HTML conversion
+to an engine.
+
+For specs to be built, provide build config and navigation
+in the YAML frontmatter of corresponding `_specs/<specname>.adoc` file
+as described in spec YAML frontmatter sample.
+
 For now, only the `png_diagrams` engine is supported, with Metanorma-based
 project build engine to come.
 
-During project site build, Jekyll pulls software docs or spec contents
-that are hosted under that project site. For spec contents, Jekyll runs
-a build, if specified.
+During project site build, Jekyll pulls spec sources that’s part of the
+site and builds them, converting pages from source markup to HTML using
+the engine specified, and adding the navigation.
 
 ### Symbol
 
@@ -569,7 +581,7 @@ This means when Jekyll encounters `{% include <include_name> %}`
 in a template, it looks first in `<site root>/<include_name>`,
 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.
+`_includes/` directory of your site.
 
 
 ## Theme layouts
@@ -694,8 +706,8 @@ theme-generated files and directories from adding chaos to your Git staging.
 _software/*/.git
 _software/*/docs
 _software/_*_repo
-_specs/*/.git
-_specs/*/docs
+_specs/*/
+!_specs/*.*
 parent-hub/*
 ```
 

data/_includes/item-doc-page.html

@@ -11,7 +11,7 @@
   {% assign nav = item_docs | where_exp: "item", "item.path contains 'docs/navigation'" | first %}
 
   {% if nav == nil %}
-    {% assign nav = page.navigation %}
+    {% assign nav = page.navigation || layout.navigation %}
   {% endif %}
 
   {% assign num_nav_sections = nav.sections | size %}
@@ -20,7 +20,7 @@
 
   <nav class="docs-nav">
 
-    {% if is_docs_landing == false %}
+    {% if is_docs_landing != true %}
       <header class="sidebar-header">
         {% if include.item_type == 'software' %}
           <div class="logo-container">
@@ -30,6 +30,9 @@
         <h3 class="title">
           <a href="{{ product_base_url | relative_url }}">{{ item_data.title }}</a>
         </h3>
+        <span class="section-title">
+          &rarr;&nbsp;{{ page.title|replace: " ", "&nbsp;" }}
+        </span>
       </header>
 
       <section class="external-links">
@@ -106,7 +109,7 @@
           </div>
         {% endif %}
 
-        <h1 class="text">{{ page.title }}</h1>
+        <h1 class="text">{{ page.article_header_title | default: page.title }}</h1>
       </div>
 
       {% if is_docs_landing == false and item_data.docs.git_repo_url %}

data/_includes/project-doc-page.html

@@ -0,0 +1,96 @@
+{% assign product_base_url = page.url | split: "/" | slice: 0, 3 | join: "/" | append: "/" %}
+
+<section class="documentation">
+  {% assign docs_base_url = product_base_url | append: "docs/" %} 
+  {% assign nav = page.navigation | default: layout.navigation %}
+  {% assign num_nav_sections = nav.sections | size %}
+
+  <nav class="docs-nav">
+
+    <header class="sidebar-header">
+      <h3 class="title">
+        <a href="javascript: void 0;">{{ include.header_main }}</a>
+      </h3>
+      {% if include.header_side %}
+      <span class="section-title">
+        &rarr;&nbsp;{{ include.header_side|replace: " ", "&nbsp;" }}
+      </span>
+      {% endif %}
+    </header>
+
+    {% for section in nav.sections %}
+      <section>
+        <h4 class="section-title">{{ section.name }}</h4>
+        <ul class="section-items">
+          {% for item in section.items %}
+            {% if item.path %}
+              {% comment %}Spec contents{% endcomment %}
+              {% assign item_path = item.path %}
+              {% assign link = product_base_url | append: item_path | append: "/" %}
+            {% else %}
+              {% comment %}Software docs{% endcomment %}
+              {% assign item_path = item %}
+              {% assign link = docs_base_url | append: item_path | append: "/" %}
+            {% endif %}
+
+            {% assign linked_page = include.items | where_exp: "item", "item.url contains link" | first %}
+
+            {% if item.title %}
+              {% assign item_title = item.title %}
+            {% elsif item.ignore_missing != true %}
+              {% assign item_title = linked_page.title %}
+            {% endif %}
+
+            {% if linked_page or item.ignore_missing %}
+              {% if page.url != link %}
+                <li class="item">
+                  <a href="{{ link | relative_url }}">
+                    {{ item_title }}
+                  </a>
+              {% else %}
+                <li class="item selected">
+                  <span>
+                    {{ item_title }}
+                  </span>
+              {% endif %}
+            {% else %}
+              <li class="item">
+                <span class="tbd">
+                  {% if item.title %}
+                    {{ item.title }}
+                  {% else %}
+                    {{ item }}
+                  {% endif %}
+                </span>
+            {% endif %}
+
+            {% assign link = "" %}
+          {% endfor %}
+        </ul>
+      </section>
+    {% endfor %}
+  </nav>
+
+  <article>
+    <header>
+      <div class="title">
+        {% if include.item_type == 'software' and page.url == product_base_url %}
+          <div class="logo-container">
+            {% include software-symbol.html item_id=page.id %}
+          </div>
+        {% endif %}
+
+        <h1 class="text">{{ page.article_header_title | default: page.title }}</h1>
+      </div>
+
+      <div>
+        <h3 class="lead">{{ page.description }}</h3>
+      </div>
+    </header>
+
+    <div class="body">
+      {{ content }}
+    </div>
+
+  </article>
+</section>

data/_sass/headroom.scss

@@ -10,7 +10,7 @@
 }
 
 body.with-headroom {
-  &.layout--product, &.layout--spec {
+  &.layout--docs, &.layout--product, &.layout--spec {
     .underlay.header {
       position: fixed;
       top: 0;

data/_sass/jekyll-theme-open-project.scss

@@ -666,7 +666,8 @@ main {
     @extend .main-article;
   }
   &.layout--spec > main,
-  &.layout--product > main {
+  &.layout--product > main,
+  &.layout--docs > main {
     > .documentation:only-child {
       @include docs-page($primary-dark-color);
     }

data/_sass/open-project-base.scss

@@ -132,6 +132,7 @@ a {
   background: white;
   display: block;
   position: relative;
+  overflow: hidden;
 
   &:link, &:hover, &:visited {
     color: inherit;
@@ -204,6 +205,8 @@ a {
     .tags {
       list-style: none;
       padding: 0;
+      overflow: hidden;
+      text-overflow: ellipsis;
 
       > li {
         display: inline;

data/_sass/open-project-mixins.scss

@@ -517,6 +517,39 @@
           cursor: pointer;
           padding-top: 10px;
           padding-bottom: 10px;
+
+          &:after {
+            content: "▼";
+          }
+
+          .item-type {
+            display: none;
+            margin-right: 10px;
+          }
+          .title {
+            flex-grow: 0;
+          }
+          .section-title {
+            margin-left: 10px;
+            margin-right: 10px;
+            overflow: hidden;
+            text-overflow: ellipsis;
+            flex-grow: 1;
+            transition: transform .2s ease-out;
+          }
+
+          &.headroom--top {
+            .section-title {
+              transform: translateY(-5em);
+              transition: none;
+            }
+          }
+
+          &.unpinned {
+            .item-type, .subsection {
+              display: inline-block;
+            }
+          }
         }
 
         &.expanded {
@@ -527,11 +560,6 @@
           border-bottom: none;
         }
       }
-
-      &.pinned {
-        z-index: 4;
-        transform: translateY(0);
-      }
     }
   }
 }

data/assets/js/opf.js

@@ -127,7 +127,6 @@
     docsNav.classList.add('top-expandable');
 
     docsNav.style.top = '' + topHeaderHeight + 'px';
-    docsNavHeader.innerHTML = docsNavHeader.innerHTML + ' ▼';
     docsNavSections.forEach(function (el) {
       el.style.transition = 'opacity .2s cubic-bezier(0.23, 1, 0.32, 1)';
     });
@@ -244,13 +243,13 @@
 
   var collapsibleHeader;
 
-  if (document.querySelector('body.layout--product .documentation:not(.docs-landing), body.layout--spec .documentation:not(.docs-landing)') != null) {
+  if (document.querySelector('body.layout--docs .documentation, body.layout--product .documentation:not(.docs-landing), body.layout--spec .documentation:not(.docs-landing)') != null) {
     collapsibleHeader = initCollapsibleHeader(
       document.querySelector('.underlay.header'),
       hamburgerMenu);
   }
 
-  var docsRoot = body.querySelector('body.layout--product .documentation:not(.docs-landing), body.layout--spec .documentation:not(.docs-landing)');
+  var docsRoot = body.querySelector('body.layout--docs .documentation, body.layout--product .documentation:not(.docs-landing), body.layout--spec .documentation:not(.docs-landing)');
   var collapsibleDocsNav;
 
   if (docsRoot !== null) {
@@ -258,11 +257,17 @@
     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); }
+  var docArticleSelectorPrefixes = [
+    'body.layout--docs .documentation > article',
+    'body.layout--spec .documentation > article',
+    'body.layout--product .documentation:not(.docs-landing) > article '];
+
+  for (var prefix of docArticleSelectorPrefixes) {
+    var docArticleHeaderNavToggle = document.querySelector(prefix + '> header > nav > button.docs-nav-toggle');
+    var docArticleFooterNavToggle = document.querySelector(prefix + '> footer > nav > button.docs-nav-toggle');
+    for (var el of [docArticleFooterNavToggle, docArticleHeaderNavToggle]) {
+      if (el) { el.addEventListener('click', collapsibleDocsNav.toggle); }
+    }
   }
 
   if (triggerEl !== null && inputEl !== null && topMenuEl !== null) {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-open-project
 version: !ruby/object:Gem::Version
-  version: 1.1.25
+  version: 1.1.26
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-26 00:00:00.000000000 Z
+date: 2018-12-08 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.25
+        version: 1.1.26
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.1.25
+        version: 1.1.26
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -172,6 +172,7 @@ files:
 - _includes/nav-links.html
 - _includes/nav-page-link.html
 - _includes/post-card.html
+- _includes/project-doc-page.html
 - _includes/project-nav.html
 - _includes/scripts.html
 - _includes/social-links.html