fni-docs-theme 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e933eb121bdcdfa9df47685ce09f42f27071fd179cfe6572fbbcefa3111d0a9f
-  data.tar.gz: '0950106a53c0b4b1de583e9ebcd8a053834ef656faf500690939cc7e25e2d96a'
+  metadata.gz: 293de6305ef2f25244dab21522972c4c71789fc3218c661fa2a6de84d1e44296
+  data.tar.gz: e48256ed80fecb7a43b8d8a0f83aa307351fa03939d8e92c617a010a26fdb030
 SHA512:
-  metadata.gz: d1fb045cea52ce688d50b0bf0d231d6534315c390d88dce8f7fbf4b7b0e568dc9a94ac7787ef5d6302cdfa34c6db67ce7d7edbe93af5ce4a871c3b9cb98a9092
-  data.tar.gz: 8e05c044f0db819f2812e96e008d35fc90c91945d674e981856793331ae8f843703eca8e374775484147fdf1d24ca0cd5995f9cb97b5f3df2763bda17cdabe1a
+  metadata.gz: 4099d8b27df6a76b5efc47a51100eaae9d90144746197fe1cb2b941df713386f3bad73962f8594c7393ff28bb18c6e0d2ca4d22be3c3afa425a0b78cf21d1e97
+  data.tar.gz: 33fbea2152a2a564d8232b160c5515834ffae24794ebbd469f62b25676a7e5b9eeac46e250df3ed25f3b93069516cc75e616f52851f0b4001c8974954c2a81b2

data/README.md

@@ -29,10 +29,22 @@ plugins:
 
 [View the documentation](https://pmarsceill.github.io/just-the-docs/) for usage information.
 
+## Local Testing
+
+```bash
+> ./serve
+```
+
+Access the site at http://localhost:4000/fni-docs-theme/
+
 ## Publishing
 
 This theme/plugin is published as fni-docs-theme to rubygems.org.
 
+To publish a new version:
+* Bump the version in the fni-docs-theme.gemspec
+* Run the Publish Gem Github Action
+
 ## License
 
 The theme is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/_layouts/default.html

@@ -100,28 +100,13 @@ layout: table_wrappers
     <div id="main-content-wrap" class="main-content-wrap">
       {% unless page.url == "/" %}
         {% if page.parent %}
-          {%- for node in pages_list -%}
-            {%- if node.parent == nil -%}
-              {%- if page.parent == node.title or page.grand_parent == node.title -%}
-                {%- assign first_level_url = node.url | absolute_url -%}
-              {%- endif -%}
-              {%- if node.has_children -%}
-                {%- assign children_list = pages_list | where: "parent", node.title -%}
-                {%- for child in children_list -%}
-                  {%- if page.url == child.url or page.parent == child.title -%}
-                    {%- assign second_level_url = child.url | absolute_url -%}
-                  {%- endif -%}
-                {%- endfor -%}
-              {%- endif -%}
-            {%- endif -%}
-          {%- endfor -%}
           <nav aria-label="Breadcrumb" class="breadcrumb-nav">
             <ol class="breadcrumb-nav-list">
               {% if page.grand_parent %}
-                <li class="breadcrumb-nav-list-item"><a href="{{ first_level_url }}">{{ page.grand_parent }}</a></li>
-                <li class="breadcrumb-nav-list-item"><a href="{{ second_level_url }}">{{ page.parent }}</a></li>
+                <li class="breadcrumb-nav-list-item"><a href="{{ page.grand_parent_url | absolute_url }}">{{ page.grand_parent }}</a></li>
+                <li class="breadcrumb-nav-list-item"><a href="{{ page.parent_url | absolute_url }}">{{ page.parent }}</a></li>
               {% else %}
-                <li class="breadcrumb-nav-list-item"><a href="{{ first_level_url }}">{{ page.parent }}</a></li>
+                <li class="breadcrumb-nav-list-item"><a href="{{ page.parent_url | absolute_url }}">{{ page.parent }}</a></li>
               {% endif %}
               <li class="breadcrumb-nav-list-item"><span>{{ page.title }}</span></li>
             </ol>
@@ -139,7 +124,7 @@ layout: table_wrappers
           <hr>
           <h2 class="text-delta">Subtopics</h2>
           <ul>
-            {% for child in page.nav %}
+            {% for child in page.children %}
               <li>
                 <a href="{{ child.url | absolute_url }}">{{ child.title }}</a>{% if child.summary %} - {{ child.summary }}{% endif %}
               </li>

data/lib/generators/nav-generator.rb

@@ -3,22 +3,27 @@ module NavGenerator
     # Generate a sorted page heirarchy based on parent / grand_parent
     # TODO: If a new page is added to the site, need to hook into incremental rebuild and flush nav.html cache
     def generate(site)
-      nav = nav_for_parent(site.pages, nil)
+      nav = nav_for_parent(site.pages, nil, nil)
       
       # Attach nav data to the default layout
       site.layouts['default'].data['nav'] = nav
     end
 
-    def nav_for_parent(page_list, parent)
+    def nav_for_parent(page_list, parentPage, grandParentPage)
+      parentPageTitle = parentPage && parentPage.data['title']
       pages = page_list
-        .filter { |page| page.data['parent'] == parent && page.data['title'] != nil && page.data['nav_exclude'] != true }
+        .filter { |page| page.data['parent'] == parentPageTitle && page.data['title'] != nil && page.data['nav_exclude'] != true }
         .sort_by { |page| [page.data['nav_order'] || 999, page.data['title']] }  
 
       nav = pages.map { |page|
-        children = page.data['has_children'] && nav_for_parent(page_list, page.data['title'])
+        children = page.data['has_children'] && nav_for_parent(page_list, page, parentPage)
 
         # Attach the child data to the page itself, used to render the footer Table of Contents
-        page.data['nav'] = children
+        page.data['children'] = children
+        
+        # Attach parent/grandparent URLs for rendering breadcrumb
+        page.data['parent_url'] = parentPage&.url
+        page.data['grand_parent_url'] = grandParentPage&.url
         
         {
           'title' => page.data['title'],

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fni-docs-theme
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Patrick Marsceill
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-31 00:00:00.000000000 Z
+date: 2022-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -198,7 +198,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Fork of just-the-docs