jekyll-theme-open-project 1.1.24 → 1.1.25

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8fce901d2f3924596242e699f0e9719a86a9cb071a3e854489475ac5c650529
-  data.tar.gz: 8fb7ff15b83a37d4c6faf071bce7d30cc8be6b2ce6535550f1ee39d1ea23e07b
+  metadata.gz: e09f5fa2c2fd4362589ab6084c27892a7a9074a4bca12cf5eee38724552891da
+  data.tar.gz: 01de902102f9fdf21af5c09b0622825b813cdb4a3c5625ac8ee18d8cba58f369
 SHA512:
-  metadata.gz: f4600c9320dc30fea748bc24ddf95ef2b9db966d6c933088669716fa36edd3df8c244a4bc51f8a34a26fd0f90fbc36348faa186de4c938597e2c4fd92f654d57
-  data.tar.gz: cc18435994f4d649b31febddc894ad7b1a92ad9bcc68884c444fa53e5deb22248b237bca3dfe81dec7a6125dbffe2ac51edc89574c4fbb7caa61d13e37c08969
+  metadata.gz: faf6286e377c24a56a813e202dbf31fb423f97a446123c35aa75721eeb7fb7c3b00cf427b8891dabb60cc9b27956713d45f871017c89584cd340da8d3cecb5bd
+  data.tar.gz: c92a53183417eaa8496cf4c0cdaee5d7fc9d8dfe85082b1778414c3958bf2e6f9f64d38812950fa2be9420509a67ffe9e38d9249d08a707103eff23bdb7dec28

data/README.md

@@ -275,6 +275,15 @@ home_url: <URL to standalone project site>
 # (see hub site configuration for tag namespace setup).
 # Avoid long namespace/tag combos as they can overflow item’s card widget.
 tags: [Ruby, Python, RFC, "<some_namespace_id>:<appropriate_tag>"]
+
+# NOTE: Must match corresponding hub site’s configuration entry.
+tag_namespaces:
+  software:
+    namespace_id: "Human-readable namespace name"
+    # E.g.:
+    # writtenin: "Written in"
+  specs:
+    namespace_id: "Human-readable namespace name"
 ```
 
 ### Project index page
@@ -459,9 +468,9 @@ source_url: https://example.com/spec-source-markup
 # Required.
 ```
 
-### Documentation for specs and software
+### Documentation for software, and specification contents
 
-Documentation contents for software should be kept in software
+**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:
@@ -477,12 +486,37 @@ sections:
     - 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
+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 will pull docs for software products
-that are hosted under that project site.
+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
+  build:
+    engine: png_diagrams
+
+navigation:
+  sections:
+  - name: Model diagrams
+    items:
+    - title: "CSAND Normal Document"
+      path: "Csand_NormalDocument"
+      description: ""
+      ignore_missing: yes
+```
+
+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.
 
 ### Symbol
 

data/_includes/home-project.html

@@ -53,7 +53,7 @@
             </p>
 
             <footer class="meta">
-              {% include tag-list.html tags=item.tags %}
+              {% include tag-list.html tags=item.tags item_type="software" %}
 
               {% if item.last_update %}
                 <section class="last-update">
@@ -104,7 +104,7 @@
           </p>
 
           <footer class="meta">
-            {% include tag-list.html tags=item.tags %}
+            {% include tag-list.html tags=item.tags item_type="specs" %}
 
             {% if item.last_update %}
               <section class="last-update">

data/_includes/item-doc-page.html

@@ -5,11 +5,15 @@
   {% assign is_docs_landing = false %}
 {% endif %}
 
-<section class="documentation {% if is_docs_landing %}docs-landing{% endif %}">
+<section class="documentation {% if is_docs_landing %}docs-landing{% endif %} {{ include.item_type }}">
   {% assign docs_base_url = product_base_url | append: "docs/" %} 
   {% assign item_docs = include.items | where_exp: "item", "item.url contains docs_base_url" %}
   {% assign nav = item_docs | where_exp: "item", "item.path contains 'docs/navigation'" | first %}
 
+  {% if nav == nil %}
+    {% assign nav = page.navigation %}
+  {% endif %}
+
   {% assign num_nav_sections = nav.sections | size %}
 
   {% assign item_data = include.items | where_exp: "item", "item.url == product_base_url" | first %}
@@ -22,17 +26,17 @@
           <div class="logo-container">
             {% include software-symbol.html item_id=page.id %}
           </div>
-          <h3 class="title">
-            <a href="{{ product_base_url | relative_url }}">{{ item_data.title }}</a>
-          </h3>
         {% endif %}
+        <h3 class="title">
+          <a href="{{ product_base_url | relative_url }}">{{ item_data.title }}</a>
+        </h3>
       </header>
 
       <section class="external-links">
         {% include item-external-links.html item_type=include.item_type item_data=item_data %}
       </section>
 
-    {% elsif num_nav_sections > 0 %}
+    {% elsif num_nav_sections > 0 and include.item_type == 'software' %}
       <header class="sidebar-header">
         <h3 class="title">
           Documentation
@@ -45,27 +49,47 @@
         <h4 class="section-title">{{ section.name }}</h4>
         <ul class="section-items">
           {% for item in section.items %}
-            {% assign link = docs_base_url | append: item | append: "/" %}
+            {% 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 page.url != link and linked_page %}
-              <li class="item">
-                <a href="{{ link | relative_url }}">
-                  {{ linked_page.title }}
-                </a>
-            {% else %}
-              {% if page.url == link %}
+            {% 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>
-                    {{ linked_page.title }}
-                  </span>
-              {% else %}
-                <li class="item">
-                  <span class="tbd">
-                    {{ item }}
+                    {{ 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>
@@ -85,7 +109,7 @@
         <h1 class="text">{{ page.title }}</h1>
       </div>
 
-      {% if is_docs_landing == false %}
+      {% if is_docs_landing == false and item_data.docs.git_repo_url %}
         <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>
@@ -107,7 +131,7 @@
       {{ content }}
     </div>
 
-    {% if is_docs_landing == false %}
+    {% if is_docs_landing == false and item_data.docs.git_repo_url %}
     <footer>
       <nav>
         <button class="docs-nav-toggle">Show table of contents</button>

data/_layouts/default.html

@@ -15,6 +15,18 @@
     <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css">
   {% endif %}
 
+  {% if page.extra_stylesheets %}
+    {% for ss in page.extra_stylesheets %}
+      <link rel="stylesheet" href="{{ ss.href }}" integrity="{{ ss.integrity }}" crossorigin="{{ ss.crossorigin }}">
+    {% endfor %}
+  {% endif %}
+
+  {% if page.extra_scripts %}
+    {% for sc in page.extra_scripts %}
+      <script src="{{ sc.src }}" integrity="{{ sc.integrity }}" crossorigin="{{ sc.crossorigin }}"></script>
+    {% endfor %}
+  {% endif %}
+
   {% seo %}
 </head>
 

data/_sass/headroom.scss

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

data/_sass/open-project-base.scss

@@ -445,7 +445,8 @@ body {
 }
 body > .underlay,
 body > main,
-body > main > .underlay {
+body > main > .underlay,
+.item-filter {
   display: flex;
   flex-flow: column nowrap;
   @media screen and (min-width: $bigscreen-breakpoint) {
@@ -458,6 +459,10 @@ body > main > .underlay {
   }
 }
 
+nav.item-filter > * {
+  @include wide-container();
+}
+
 header,
 footer,
 section,
@@ -467,12 +472,6 @@ article {
   body > .underlay > &,
   body > main > &,
   body > main > .underlay > & {
-    @media screen and (min-width: $bigscreen-breakpoint) {
-      padding: 0;
-      width: $bigscreen-breakpoint - $gutter * 2;
-    }
-    @media screen and (min-width: $widescreen-breakpoint) {
-      width: $widescreen-breakpoint - $gutter * 2;
-    }
+    @include wide-container();
   }
 }

data/_sass/open-project-mixins.scss

@@ -14,6 +14,16 @@
   }
 }
 
+@mixin wide-container() {
+  @media screen and (min-width: $bigscreen-breakpoint) {
+    padding: 0;
+    width: $bigscreen-breakpoint - $gutter * 2;
+  }
+  @media screen and (min-width: $widescreen-breakpoint) {
+    width: $widescreen-breakpoint - $gutter * 2;
+  }
+}
+
 @mixin padded-code-snippet() {
   padding: 0 1em;
   margin: 0 .2em;
@@ -234,45 +244,6 @@
     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;
     }
@@ -284,6 +255,7 @@
 
       .title {
         flex: 1;
+        white-space: nowrap;
         line-height: 1;
         font-weight: normal;
         font-size: 15px;
@@ -369,6 +341,7 @@
 
     > header > nav {
       margin-top: -2em;
+      margin-bottom: 4em;
     }
 
     > footer > nav {
@@ -443,6 +416,12 @@
     }
   }
 
+  &.specs {
+    > article {
+      max-width: none;
+    }
+  }
+
   @media screen and (min-width: $bigscreen-breakpoint) {
     flex-flow: row nowrap;
 
@@ -497,4 +476,62 @@
       }
     }
   }
+
+  &.with-expandable-toc {
+    // Is enabled by a script.
+
+    position: relative;
+
+    > article {
+      border-left-width: 0;
+      padding-top: 2em;
+
+      > header, > .body {
+        margin-left: 0;
+      }
+    }
+
+    > .docs-nav {
+      z-index: 4;
+
+      &.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 -5px 20px 0 rgba(black, 0.4);
+          z-index: 6;
+          overflow-y: scroll;
+          background: white;
+          border-bottom: none;
+        }
+      }
+
+      &.pinned {
+        z-index: 4;
+        transform: translateY(0);
+      }
+    }
+  }
 }

data/assets/js/opf.js

@@ -123,14 +123,11 @@
     // to account for top header height
     var topHeaderHeight = collapsibleHeader.getHeaderHeight();
 
-    article.style.paddingTop = '2em';
-
+    docsRoot.classList.add('with-expandable-toc');
     docsNav.classList.add('top-expandable');
-    docsNav.style.zIndex = '4';
-    docsNav.style.top = '' + topHeaderHeight + 'px';
 
+    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)';
     });
@@ -247,13 +244,13 @@
 
   var collapsibleHeader;
 
-  if (document.querySelector('body.layout--product .documentation:not(.docs-landing)') != null) {
+  if (document.querySelector('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)');
+  var docsRoot = body.querySelector('body.layout--product .documentation:not(.docs-landing), body.layout--spec .documentation:not(.docs-landing)');
   var collapsibleDocsNav;
 
   if (docsRoot !== null) {
@@ -273,6 +270,8 @@
   }
 
   var indexFilterEl = document.querySelector('nav.item-filter');
-  initIndexFilter(indexFilterEl);
+  if (indexFilterEl !== null) {
+    initIndexFilter(indexFilterEl);
+  }
 
 }());

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-open-project
 version: !ruby/object:Gem::Version
-  version: 1.1.24
+  version: 1.1.25
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-16 00:00:00.000000000 Z
+date: 2018-11-26 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.24
+        version: 1.1.25
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.1.24
+        version: 1.1.25
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement