jekyll-theme-open-project 1.1.27 → 1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3dbc9537d264d1f95020880d6a37de671f70af3f62efbfa6de53bf1da1dd8460
-  data.tar.gz: ad04d62df9f70a6e4bbd298c8604a509896261935e7bc2bcaeeab33fa6b459a5
+  metadata.gz: eff8fded69928516a4760e368278fe22d4ffa118ee215a83886b3e5932172537
+  data.tar.gz: d8721bb216aa04aa8a3fc05bb6557787c2471bed56ae4fc5b2766cbf17fb5dec
 SHA512:
-  metadata.gz: 20332e69d37880885fca43c6451003a78f79e18b7a6d67385ab86b101cde2ecb273ec63131fc04a838d5e68fed43d7e4a5e18d39ffb29a526e166c40d3897380
-  data.tar.gz: b9de38214b0ee900e22e8697eda9f44e4b8d6eea84e41816fcbf3f0479698ea746056b573a94c7ec52eb0d7568fef4a0e7208b2e7cae987df3bfbe2561ad4425
+  metadata.gz: 1142e54262a3be29436e02df0882d15e15731fec24c047430663dc1f8411d8ebd9d5f0d4385e83795f41178ebd04c5eba213dd7b9b866a66fe798b80ebd4d6f3
+  data.tar.gz: 45ec5860de2593bf5cb399fe167b5eeff4e2de64bc3eab76408e34160046577070f2feabb4a46a6bb578475c20422d7dc158b5d493723e78cbe01a516ecf1219

data/README.md

@@ -456,18 +456,18 @@ in above sample, place a file called `navigation.md` containing
 only frontmatter, following this sample:
 
 ```yaml
-sections:
+items:
 - name: Introduction
   items:
-    - overview
-    - installation
+    - { title: Overview, path: overview/ }
+    - { title: Installation, path: installation/ }
 - name: Usage
   items:
-    - basic
+    - { title: Basic, path: basic-usage/ }
 ```
 
 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
+`installation.md`, and `basic-usage.md`. Each file must contain
 standard YAML frontmatter with at least `title` specified.
 
 During project site build, Jekyll pulls docs for software that’s part of the

data/_includes/_nav-item.html

@@ -0,0 +1,33 @@
+{% assign base_url = include.base_url | default: "" %}
+{% assign link = base_url | append: include.item.path %}
+
+{% if include.item == include.selected_item %}
+  {% assign selected = true %}
+{% elsif include.selected_item == null and page.url == link %}
+  {% assign selected = true %}
+{% else %}
+  {% assign selected = false %}
+  {% comment %} Otherwise in Liquid selected value falls through to next include instance {% endcomment %}
+{% endif %}
+
+<li class="item {% if selected %}selected{% endif %}">
+  <div class="item-title">
+    {% if include.item.path == null or selected == true %}
+      <span>
+        {{ include.item.title }}
+      </span>
+    {% else %}
+      <a href="{{ link }}">
+        {{ include.item.title }}
+      </a>
+    {% endif %}
+  </div>
+
+  {% if include.item.items %}
+    <ul class="nav-items subitmes">
+      {% for item in include.item.items %}
+        {% include _nav-item.html item=item base_url=include.base_url selected_item=include.selected_item %}
+      {% endfor %}
+    </ul>
+  {% endif %}
+</li>

data/_includes/item-doc-page.html

@@ -1,104 +1,61 @@
 {% assign product_base_url = page.url | split: "/" | slice: 0, 3 | join: "/" | append: "/" %}
+{% assign docs_base_url = product_base_url | append: "docs/" %}
+
 {% if page.url == product_base_url %}
   {% assign is_docs_landing = true %}
 {% else %}
   {% assign is_docs_landing = false %}
 {% 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 %}
+{% 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 %}
+{% assign item_data = include.items | where_exp: "item", "item.url == product_base_url" | first %}
 
-  {% if nav == nil %}
-    {% assign nav = page.navigation || layout.navigation %}
-  {% endif %}
+{% if nav == nil %}
+  {% assign nav = page.navigation || layout.navigation %}
+{% endif %}
 
-  {% assign num_nav_sections = nav.sections | size %}
+{% if is_docs_landing != true %}
+  <header class="documentation-header">
+    <span class="section-title">
+      {{ page.title|replace: " ", "&nbsp;" }}
+    </span>
 
-  {% assign item_data = include.items | where_exp: "item", "item.url == product_base_url" | first %}
+    <div class="nav-header">
+      {% if include.item_type == 'software' %}
+        <div class="logo-container">
+          {% include software-symbol.html item_id=page.id %}
+        </div>
+      {% endif %}
 
-  <nav class="docs-nav">
+      <h3 class="title">
+        <a href="{{ product_base_url | relative_url }}">{{ item_data.title }}</a>
+      </h3>
 
-    {% if is_docs_landing != true %}
-      <header class="sidebar-header">
-        {% if include.item_type == 'software' %}
-          <div class="logo-container">
-            {% include software-symbol.html item_id=page.id %}
-          </div>
-        {% endif %}
-        <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">
-        {% include item-external-links.html item_type=include.item_type item_data=item_data %}
-      </section>
-
-    {% elsif num_nav_sections > 0 and include.item_type == 'software' %}
-      <header class="sidebar-header">
-        <h3 class="title">
-          Documentation
-        </h3>
-      </header>
-    {% endif %}
+      <span class="nav-toggle-icon">
+        <i class="open far fa-ellipsis-v"></i>
+        <i class="close far fa-times"></i>
+      </span>
+    </div>
+  </header>
+{% endif %}
 
-    {% 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>
+<section class="documentation {% if is_docs_landing %}docs-landing{% endif %} {{ include.item_type }}">
+
+  {% if is_docs_landing == false %}
+    <nav class="docs-nav">
+      <ul class="nav-items">
+        <li class="item external-links">
+          {% include item-external-links.html item_type=include.item_type item_data=item_data %}
+        </li>
+
+        {% for item in nav.items %}
+          {% include _nav-item.html item=item base_url=docs_base_url %}
+        {% endfor %}
+      </ul>
+    </nav>
+  {% endif %}
 
   <article>
     <header>
@@ -114,7 +71,7 @@
 
       {% if is_docs_landing == false and item_data.docs.git_repo_url %}
         <nav>
-          <button class="docs-nav-toggle">Show table of contents</button>
+          <button class="docs-nav-toggle">Toggle 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 %}
@@ -134,13 +91,13 @@
       {{ content }}
     </div>
 
-    {% if is_docs_landing == false and item_data.docs.git_repo_url %}
-    <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>
+    {% assign nav_size = nav.items | size %}
+    {% if is_docs_landing and nav_size > 0 %}
+      <ul class="nav-items">
+        {% for item in nav.items %}
+          {% include _nav-item.html item=item base_url=docs_base_url %}
+        {% endfor %}
+      </ul>
     {% endif %}
 
   </article>

data/_includes/item-external-links.html

@@ -1,5 +1,5 @@
 {% if include.item_type == 'software' and item_data.repo_url or item_data.docs_url %}
-  <ul class="section-items">
+  <ul class="nav-items">
     {% if item_data.repo_url %}
       <li class="item">
         <a href="{{ item_data.repo_url }}">
@@ -8,14 +8,14 @@
               <i class="fab fa-github"></i>
             </span>
             <span class="lbl">
-              GitHub Repository
+              GitHub
             </span>
           {% else %}
             <span class="ico">
               <i class="far fa-code"></i>
             </span>
             <span class="lbl">
-              Source Repository
+              Source Code
             </span>
           {% endif %}
         </a> {% endif %}
@@ -27,21 +27,21 @@
               <i class="far fa-gem"></i>
             </span>
             <span class="lbl">
-              API reference at RubyDocs
+              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
+              Docs.rs
             </span>
           {% else %}
             <span class="ico">
               <i class="far fa-book"></i>
             </span>
             <span class="lbl">
-              Documentation
+              Docs
             </span>
           {% endif %}
         </a> {% endif %}

data/_includes/project-doc-page.html

@@ -1,70 +0,0 @@
-{% assign product_base_url = "/docs/" %}
-
-<section class="documentation {{ page.html-class }}">
-  {% 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 %}
-            {% assign item_path = item.path %}
-            {% assign link = product_base_url | append: item_path %}
-
-            {% if page.url != link %}
-              <li class="item">
-                <a href="{{ link }}">
-                  {{ item.title }}
-                </a>
-            {% else %}
-              <li class="item selected">
-                <span>
-                  {{ item.title }}
-                </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/_layouts/default.html

@@ -32,6 +32,7 @@
 
 {% assign num_projects = site.projects | size %}
 <body class="
+    {{ page.html-class }} {{ layout.html-class }}
     {% if num_projects > 0 %}site--hub{% else %}site--project{% endif %}
     {% if page.layout %}layout--{{ page.layout }}{% endif %}">
   <div class="underlay header">

data/_layouts/docs-base.html

@@ -0,0 +1,74 @@
+---
+layout: default
+---
+
+{% assign nav = page.navigation | default: layout.navigation %}
+{% assign num_nav_sections = nav.sections | size %}
+
+{% for item in nav.items %}
+  {% assign topmost_item = item %}
+
+  {% if page.url == item.path %}
+    {% assign selected_item = item %}
+    {% assign selected_section = item %}
+  {% endif %}
+
+  {% if item.items %}
+    {% for item in item.items %}
+        {% if page.url == item.path %}
+          {% assign selected_item = item %}
+          {% assign selected_section = topmost_item %}
+        {% endif %}
+    {% endfor %}
+  {% endif %}
+{% endfor %}
+
+
+<header class="documentation-header">
+  {% if page.title %}
+  <span class="section-title">
+    {{ page.title|replace: " ", "&nbsp;" }}
+  </span>
+  {% endif %}
+
+  <div class="nav-header">
+    <h3 class="title">
+      <a href="javascript: void 0;">
+        {{ layout.docs_title }}{% if selected_section %}: {{ selected_section.title }}{% endif %}
+      </a>
+    </h3>
+
+    <span class="nav-toggle-icon">
+      <i class="open far fa-ellipsis-v"></i>
+      <i class="close far fa-times"></i>
+    </span>
+  </div>
+</header>
+
+
+<section class="documentation {{ page.html-class }}">
+  <nav class="docs-nav">
+    <ul class="nav-items">
+      {% for item in nav.items %}
+        {% include _nav-item.html selected_item=selected_item item=item %}
+      {% endfor %}
+    </ul>
+  </nav>
+
+  <article>
+    <header>
+      <div class="title">
+        <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>