From 93f93f48a712aeee2ef6d869613efe66ba0e2dfc Mon Sep 17 00:00:00 2001
From: Silvio Giebl <silvio.giebl@hivemq.com>
Date: Thu, 9 Jul 2020 21:07:24 +0200
Subject: [PATCH 01/10] Added doc collections and categories

---
 _includes/nav.html              |  4 ++--
 _layouts/default.html           | 14 +++++++++++++-
 _sass/navigation.scss           | 23 +++++++++++++++++++++++
 assets/js/zzzz-search-data.json | 18 ++++++++++++++----
 4 files changed, 52 insertions(+), 7 deletions(-)

diff --git a/_includes/nav.html b/_includes/nav.html
index f2ec7e5..930945c 100644
--- a/_includes/nav.html
+++ b/_includes/nav.html
@@ -1,6 +1,6 @@
 <ul class="nav-list">
-  {%- assign ordered_pages_list = site.html_pages | where_exp:"item", "item.nav_order != nil" -%}
-  {%- assign unordered_pages_list = site.html_pages | where_exp:"item", "item.nav_order == nil" -%}
+  {%- assign ordered_pages_list = include.pages | where_exp:"item", "item.nav_order != nil" -%}
+  {%- assign unordered_pages_list = include.pages | where_exp:"item", "item.nav_order == nil" -%}
   {%- if site.nav_sort == 'case_insensitive' -%}
     {%- assign sorted_ordered_pages_list = ordered_pages_list | sort_natural:"nav_order" -%}
     {%- assign sorted_unordered_pages_list = unordered_pages_list | sort_natural:"title" -%}
diff --git a/_layouts/default.html b/_layouts/default.html
index 1d41a71..3510c25 100644
--- a/_layouts/default.html
+++ b/_layouts/default.html
@@ -48,7 +48,19 @@ layout: table_wrappers
       </a>
     </div>
     <nav role="navigation" aria-label="Main" id="site-nav" class="site-nav">
-      {% include nav.html %}
+      {% if site.doc_collections %}
+        {% assign doc_collections_size = site.doc_collections | size %}
+        {% for doc_collection in site.doc_collections %}
+          {% assign name = doc_collection.name %}
+          {% assign collection = site[doc_collection.collection] %}
+          {% if doc_collections_size > 1 %}
+            <div class="nav-category">{{ name }}</div>
+          {% endif %}
+          {% include nav.html pages=collection %}
+        {% endfor %}
+      {% else %}
+        {% include nav.html pages=site.html_pages %}
+      {% endif %}
     </nav>
     <footer class="site-footer">
       This site uses <a href="https://github.com/pmarsceill/just-the-docs">Just the Docs</a>, a documentation theme for Jekyll.
diff --git a/_sass/navigation.scss b/_sass/navigation.scss
index 0417b4c..521c15f 100644
--- a/_sass/navigation.scss
+++ b/_sass/navigation.scss
@@ -131,6 +131,29 @@
   }
 }
 
+.nav-category {
+  padding-top: $sp-2;
+  padding-right: $gutter-spacing-sm;
+  padding-bottom: $sp-2;
+  padding-left: $gutter-spacing-sm;
+  font-weight: 600;
+  text-align: end;
+  text-transform: uppercase;
+  border-bottom: $border $border-color;
+  @include fs-2;
+
+  @include mq(md) {
+    padding-right: $gutter-spacing;
+    padding-left: $gutter-spacing;
+    margin-top: $gutter-spacing-sm;
+    text-align: start;
+
+    &:first-child {
+      margin-top: 0;
+    }
+  }
+}
+
 // Aux nav
 
 .aux-nav {
diff --git a/assets/js/zzzz-search-data.json b/assets/js/zzzz-search-data.json
index 0a6c3e5..6bc36e8 100644
--- a/assets/js/zzzz-search-data.json
+++ b/assets/js/zzzz-search-data.json
@@ -2,8 +2,17 @@
 permalink: /assets/js/search-data.json
 ---
 {
-  {%- assign i = 0 -%}
-  {% for page in site.html_pages %}
+{% assign i = 0 -%}
+{%- assign pages_array = '' | split: '' -%}
+{%- assign pages_array = pages_array | push: site.html_pages -%}
+{%- if site.doc_collections -%}
+  {%- for doc_collection in site.doc_collections -%}
+    {%- assign collection = site[doc_collection.collection] -%}
+    {%- assign pages_array = pages_array | push: collection -%}
+  {%- endfor -%}
+{%- endif -%}
+{%- for pages in pages_array -%}
+  {%- for page in pages -%}
     {%- if page.title and page.search_exclude != true -%}
       {%- assign page_content = page.content -%}
       {%- assign heading_level = site.search.heading_level | default: 2 -%}
@@ -14,7 +23,7 @@ permalink: /assets/js/search-data.json
       {%- endfor -%}
       {%- assign parts = page_content | split: '<h1' -%}
       {%- assign title_found = false -%}
-      {% for part in parts offset: 1 %}
+      {%- for part in parts offset: 1 -%}
         {%- assign titleAndContent = part | split: '</h1>' -%}
         {%- assign title = titleAndContent[0] | replace_first: '>', '<h1>' | split: '<h1>' -%}
         {%- assign title = title[1] | strip_html -%}
@@ -54,5 +63,6 @@ permalink: /assets/js/search-data.json
         {%- assign i = i | plus: 1 -%}
       {%- endunless -%}
     {%- endif -%}
-  {% endfor %}
+  {%- endfor -%}
+{%- endfor %}
 }

From d476ce5748608235f4a6f8f74169129c9a384cff Mon Sep 17 00:00:00 2001
From: Silvio Giebl <silvio.giebl@hivemq.com>
Date: Thu, 9 Jul 2020 22:14:57 +0200
Subject: [PATCH 02/10] Updated search.rake

---
 lib/tasks/search.rake | 18 ++++++++++++++----
 1 file changed, 14 insertions(+), 4 deletions(-)

diff --git a/lib/tasks/search.rake b/lib/tasks/search.rake
index 8e6305a..73c0d5b 100644
--- a/lib/tasks/search.rake
+++ b/lib/tasks/search.rake
@@ -12,8 +12,17 @@ namespace :search do
 permalink: /assets/js/search-data.json
 ---
 {
-  {%- assign i = 0 -%}
-  {% for page in site.html_pages %}
+{% assign i = 0 -%}
+{%- assign pages_array = \'\' | split: \'\' -%}
+{%- assign pages_array = pages_array | push: site.html_pages -%}
+{%- if site.doc_collections -%}
+  {%- for doc_collection in site.doc_collections -%}
+    {%- assign collection = site[doc_collection.collection] -%}
+    {%- assign pages_array = pages_array | push: collection -%}
+  {%- endfor -%}
+{%- endif -%}
+{%- for pages in pages_array -%}
+  {%- for page in pages -%}
     {%- if page.title and page.search_exclude != true -%}
       {%- assign page_content = page.content -%}
       {%- assign heading_level = site.search.heading_level | default: 2 -%}
@@ -24,7 +33,7 @@ permalink: /assets/js/search-data.json
       {%- endfor -%}
       {%- assign parts = page_content | split: \'<h1\' -%}
       {%- assign title_found = false -%}
-      {% for part in parts offset: 1 %}
+      {%- for part in parts offset: 1 -%}
         {%- assign titleAndContent = part | split: \'</h1>\' -%}
         {%- assign title = titleAndContent[0] | replace_first: \'>\', \'<h1>\' | split: \'<h1>\' -%}
         {%- assign title = title[1] | strip_html -%}
@@ -64,7 +73,8 @@ permalink: /assets/js/search-data.json
         {%- assign i = i | plus: 1 -%}
       {%- endunless -%}
     {%- endif -%}
-  {% endfor %}
+  {%- endfor -%}
+{%- endfor %}
 }'
     end
     puts 'Done.'

From d1c3e0833722c8a432e1d697cb5ca529c64246fd Mon Sep 17 00:00:00 2001
From: Silvio Giebl <silvio.giebl@hivemq.com>
Date: Thu, 9 Jul 2020 23:33:52 +0200
Subject: [PATCH 03/10] Updated doc_collections format

---
 _layouts/default.html           | 8 ++++++--
 assets/js/zzzz-search-data.json | 3 ++-
 lib/tasks/search.rake           | 3 ++-
 3 files changed, 10 insertions(+), 4 deletions(-)

diff --git a/_layouts/default.html b/_layouts/default.html
index 3510c25..9a04ac6 100644
--- a/_layouts/default.html
+++ b/_layouts/default.html
@@ -51,8 +51,9 @@ layout: table_wrappers
       {% if site.doc_collections %}
         {% assign doc_collections_size = site.doc_collections | size %}
         {% for doc_collection in site.doc_collections %}
-          {% assign name = doc_collection.name %}
-          {% assign collection = site[doc_collection.collection] %}
+          {% assign collection_name = doc_collection[0] %}
+          {% assign collection = site[collection_name] %}
+          {% assign name = doc_collection[1].name %}
           {% if doc_collections_size > 1 %}
             <div class="nav-category">{{ name }}</div>
           {% endif %}
@@ -155,6 +156,9 @@ layout: table_wrappers
                   site.gh_edit_branch and
                   site.gh_edit_view_mode
                 %}
+                {{ site.github.repository_url }}
+                {{ site.github.source.branch }}
+                {{ site.github.source.path }}
                   <p class="text-small text-grey-dk-000 mb-0">
                     <a href="{{ site.gh_edit_repository }}/{{ site.gh_edit_view_mode }}/{{ site.gh_edit_branch }}/{{ page.path }}" id="edit-this-page">{{ site.gh_edit_link_text }}</a>
                   </p>
diff --git a/assets/js/zzzz-search-data.json b/assets/js/zzzz-search-data.json
index 6bc36e8..05b393d 100644
--- a/assets/js/zzzz-search-data.json
+++ b/assets/js/zzzz-search-data.json
@@ -7,7 +7,8 @@ permalink: /assets/js/search-data.json
 {%- assign pages_array = pages_array | push: site.html_pages -%}
 {%- if site.doc_collections -%}
   {%- for doc_collection in site.doc_collections -%}
-    {%- assign collection = site[doc_collection.collection] -%}
+    {% assign collection_name = doc_collection[0] %}
+    {% assign collection = site[collection_name] %}
     {%- assign pages_array = pages_array | push: collection -%}
   {%- endfor -%}
 {%- endif -%}
diff --git a/lib/tasks/search.rake b/lib/tasks/search.rake
index 73c0d5b..5b65682 100644
--- a/lib/tasks/search.rake
+++ b/lib/tasks/search.rake
@@ -17,7 +17,8 @@ permalink: /assets/js/search-data.json
 {%- assign pages_array = pages_array | push: site.html_pages -%}
 {%- if site.doc_collections -%}
   {%- for doc_collection in site.doc_collections -%}
-    {%- assign collection = site[doc_collection.collection] -%}
+    {% assign collection_name = doc_collection[0] %}
+    {% assign collection = site[collection_name] %}
     {%- assign pages_array = pages_array | push: collection -%}
   {%- endfor -%}
 {%- endif -%}

From b4b74f7e1dd52e043500ad7dbd40bef68f6676b2 Mon Sep 17 00:00:00 2001
From: Silvio Giebl <silvio.giebl@hivemq.com>
Date: Thu, 9 Jul 2020 23:43:33 +0200
Subject: [PATCH 04/10] Added documentation for doc_collections

---
 docs/configuration.md | 41 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 41 insertions(+)

diff --git a/docs/configuration.md b/docs/configuration.md
index 65471d2..3e7a1f8 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -22,6 +22,47 @@ Just the Docs has some specific configuration parameters that can be defined in
 
 View this site's [_config.yml](https://github.com/pmarsceill/just-the-docs/tree/master/_config.yml) file as an example.
 
+## Document collections
+
+By default, the navigation display normal [pages](https://jekyllrb.com/docs/pages/).
+Instead, you can also use [Jekyll collections](https://jekyllrb.com/docs/collections/).
+Collections group documents that semantically belong together.
+
+For example, to group all documentation, put all your files in the `_docs` folder and create the `docs` collection:
+```yaml
+# Define Jekyll collections
+collections:
+  # Define a collection named "docs", its documents reside in the "_docs" directory
+  docs:
+    permalink: "/:collection/:path/"
+    output: true
+
+# Define which collections are used in just-the-docs
+doc_collections:
+  # Reference the "docs" collection
+  docs:
+    # Give the collection a name
+    name: Documentation
+```
+
+You can reference multiple collections.
+This creates categories in the navigation with the configured names.
+```yaml
+collections:
+  docs:
+    permalink: "/:collection/:path/"
+    output: true
+  tutorials:
+    permalink: "/:collection/:path/"
+    output: true
+
+doc_collections:
+  docs:
+    name: Documentation
+  tutorials:
+    name: Tutorials
+```
+
 ## Site logo
 
 ```yaml

From 7dec48433be15614b5e062d5a467537060113d13 Mon Sep 17 00:00:00 2001
From: Silvio Giebl <silvio.giebl@hivemq.com>
Date: Thu, 9 Jul 2020 23:51:31 +0200
Subject: [PATCH 05/10] Improved documentation for doc_collections

---
 docs/configuration.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/docs/configuration.md b/docs/configuration.md
index 3e7a1f8..ee87752 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -24,11 +24,11 @@ View this site's [_config.yml](https://github.com/pmarsceill/just-the-docs/tree/
 
 ## Document collections
 
-By default, the navigation display normal [pages](https://jekyllrb.com/docs/pages/).
+By default, the navigation and search include normal [pages](https://jekyllrb.com/docs/pages/).
 Instead, you can also use [Jekyll collections](https://jekyllrb.com/docs/collections/).
 Collections group documents that semantically belong together.
 
-For example, to group all documentation, put all your files in the `_docs` folder and create the `docs` collection:
+For example, to group all documentation put all your files in the `_docs` folder and create the `docs` collection:
 ```yaml
 # Define Jekyll collections
 collections:

From 9faba6cd9160ac4b783b105d6bec1125a8d72336 Mon Sep 17 00:00:00 2001
From: Silvio Giebl <silvio.giebl@hivemq.com>
Date: Fri, 10 Jul 2020 17:26:23 +0200
Subject: [PATCH 06/10] Removed temporary changes

---
 _layouts/default.html | 3 ---
 1 file changed, 3 deletions(-)

diff --git a/_layouts/default.html b/_layouts/default.html
index 9a04ac6..5f6e664 100644
--- a/_layouts/default.html
+++ b/_layouts/default.html
@@ -156,9 +156,6 @@ layout: table_wrappers
                   site.gh_edit_branch and
                   site.gh_edit_view_mode
                 %}
-                {{ site.github.repository_url }}
-                {{ site.github.source.branch }}
-                {{ site.github.source.path }}
                   <p class="text-small text-grey-dk-000 mb-0">
                     <a href="{{ site.gh_edit_repository }}/{{ site.gh_edit_view_mode }}/{{ site.gh_edit_branch }}/{{ page.path }}" id="edit-this-page">{{ site.gh_edit_link_text }}</a>
                   </p>

From 6b27beaf583053e348c771ac383a4dc82c9663db Mon Sep 17 00:00:00 2001
From: Silvio Giebl <silvio.giebl@hivemq.com>
Date: Fri, 10 Jul 2020 19:07:01 +0200
Subject: [PATCH 07/10] Added just-the-docs.collections nav_exclude and
 search_exclude Renamed doc_collections to just-the-docs.collections

---
 _layouts/default.html           | 20 +++++++++++---------
 assets/js/zzzz-search-data.json | 15 +++++++++------
 lib/tasks/search.rake           | 17 ++++++++++-------
 3 files changed, 30 insertions(+), 22 deletions(-)

diff --git a/_layouts/default.html b/_layouts/default.html
index 5f6e664..8641d98 100644
--- a/_layouts/default.html
+++ b/_layouts/default.html
@@ -48,16 +48,18 @@ layout: table_wrappers
       </a>
     </div>
     <nav role="navigation" aria-label="Main" id="site-nav" class="site-nav">
-      {% if site.doc_collections %}
-        {% assign doc_collections_size = site.doc_collections | size %}
-        {% for doc_collection in site.doc_collections %}
-          {% assign collection_name = doc_collection[0] %}
-          {% assign collection = site[collection_name] %}
-          {% assign name = doc_collection[1].name %}
-          {% if doc_collections_size > 1 %}
-            <div class="nav-category">{{ name }}</div>
+      {% if site.just_the_docs.collections %}
+        {% assign collections_size = site.just_the_docs.collections | size %}
+        {% for collection_entry in site.just_the_docs.collections %}
+          {% assign collection_key = collection_entry[0] %}
+          {% assign collection_value = collection_entry[1] %}
+          {% assign collection = site[collection_key] %}
+          {% if collection_value.nav_exclude != true %}
+            {% if doc_collections_size > 1 %}
+              <div class="nav-category">{{ collection_value.name }}</div>
+            {% endif %}
+            {% include nav.html pages=collection %}
           {% endif %}
-          {% include nav.html pages=collection %}
         {% endfor %}
       {% else %}
         {% include nav.html pages=site.html_pages %}
diff --git a/assets/js/zzzz-search-data.json b/assets/js/zzzz-search-data.json
index 05b393d..6235244 100644
--- a/assets/js/zzzz-search-data.json
+++ b/assets/js/zzzz-search-data.json
@@ -2,14 +2,17 @@
 permalink: /assets/js/search-data.json
 ---
 {
-{% assign i = 0 -%}
+{%- assign i = 0 -%}
 {%- assign pages_array = '' | split: '' -%}
 {%- assign pages_array = pages_array | push: site.html_pages -%}
-{%- if site.doc_collections -%}
-  {%- for doc_collection in site.doc_collections -%}
-    {% assign collection_name = doc_collection[0] %}
-    {% assign collection = site[collection_name] %}
-    {%- assign pages_array = pages_array | push: collection -%}
+{%- if site.just_the_docs.collections -%}
+  {%- for collection_entry in site.just_the_docs.collections -%}
+    {%- assign collection_key = collection_entry[0] -%}
+    {%- assign collection_value = collection_entry[1] -%}
+    {%- assign collection = site[collection_key] -%}
+    {%- if collection_value.search_exclude != true -%}
+      {%- assign pages_array = pages_array | push: collection -%}
+    {%- endif -%}
   {%- endfor -%}
 {%- endif -%}
 {%- for pages in pages_array -%}
diff --git a/lib/tasks/search.rake b/lib/tasks/search.rake
index 5b65682..5c0ffe4 100644
--- a/lib/tasks/search.rake
+++ b/lib/tasks/search.rake
@@ -12,14 +12,17 @@ namespace :search do
 permalink: /assets/js/search-data.json
 ---
 {
-{% assign i = 0 -%}
-{%- assign pages_array = \'\' | split: \'\' -%}
+{%- assign i = 0 -%}
+{%- assign pages_array = '' | split: '' -%}
 {%- assign pages_array = pages_array | push: site.html_pages -%}
-{%- if site.doc_collections -%}
-  {%- for doc_collection in site.doc_collections -%}
-    {% assign collection_name = doc_collection[0] %}
-    {% assign collection = site[collection_name] %}
-    {%- assign pages_array = pages_array | push: collection -%}
+{%- if site.just_the_docs.collections -%}
+  {%- for collection_entry in site.just_the_docs.collections -%}
+    {%- assign collection_key = collection_entry[0] -%}
+    {%- assign collection_value = collection_entry[1] -%}
+    {%- assign collection = site[collection_key] -%}
+    {%- if collection_value.search_exclude != true -%}
+      {%- assign pages_array = pages_array | push: collection -%}
+    {%- endif -%}
   {%- endfor -%}
 {%- endif -%}
 {%- for pages in pages_array -%}

From b32c00a70163912c7ab2ee163dcf5641b7874dba Mon Sep 17 00:00:00 2001
From: Silvio Giebl <silvio.giebl@hivemq.com>
Date: Fri, 10 Jul 2020 20:36:05 +0200
Subject: [PATCH 08/10] Improved documentation of just-the-docs.collections
 nav_exclude and search_exclude

---
 docs/configuration.md | 35 +++++++++++++++++++++--------------
 1 file changed, 21 insertions(+), 14 deletions(-)

diff --git a/docs/configuration.md b/docs/configuration.md
index ee87752..c71a3a9 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -25,10 +25,9 @@ View this site's [_config.yml](https://github.com/pmarsceill/just-the-docs/tree/
 ## Document collections
 
 By default, the navigation and search include normal [pages](https://jekyllrb.com/docs/pages/).
-Instead, you can also use [Jekyll collections](https://jekyllrb.com/docs/collections/).
-Collections group documents that semantically belong together.
+Instead, you can also use [Jekyll collections](https://jekyllrb.com/docs/collections/) which group documents semantically together.
 
-For example, to group all documentation put all your files in the `_docs` folder and create the `docs` collection:
+For example, put all your documentation files in the `_docs` folder and create the `docs` collection:
 ```yaml
 # Define Jekyll collections
 collections:
@@ -37,12 +36,19 @@ collections:
     permalink: "/:collection/:path/"
     output: true
 
-# Define which collections are used in just-the-docs
-doc_collections:
-  # Reference the "docs" collection
-  docs:
-    # Give the collection a name
-    name: Documentation
+just_the_docs:
+  # Define which collections are used in just-the-docs
+  collections:
+    # Reference the "docs" collection
+    docs:
+      # Give the collection a name
+      name: Documentation
+      # Exclude the collection from the navigation
+      # Supports true or false (default)
+      nav_exclude: false;
+      # Exclude the collection from the search
+      # Supports true or false (default)
+      search_exclude: false;
 ```
 
 You can reference multiple collections.
@@ -56,11 +62,12 @@ collections:
     permalink: "/:collection/:path/"
     output: true
 
-doc_collections:
-  docs:
-    name: Documentation
-  tutorials:
-    name: Tutorials
+just_the_docs:
+  collections:
+    docs:
+      name: Documentation
+    tutorials:
+      name: Tutorials
 ```
 
 ## Site logo

From a086954c512c663dcaa9f6d2fff3ef9e52333ca2 Mon Sep 17 00:00:00 2001
From: Silvio Giebl <silvio.giebl@hivemq.com>
Date: Fri, 10 Jul 2020 21:05:29 +0200
Subject: [PATCH 09/10] Improved documentation for document collections

---
 docs/configuration.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/docs/configuration.md b/docs/configuration.md
index c71a3a9..8b5cb97 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -45,10 +45,10 @@ just_the_docs:
       name: Documentation
       # Exclude the collection from the navigation
       # Supports true or false (default)
-      nav_exclude: false;
+      nav_exclude: false
       # Exclude the collection from the search
       # Supports true or false (default)
-      search_exclude: false;
+      search_exclude: false
 ```
 
 You can reference multiple collections.

From 5dd6324f6103722ff71e5d9d0e4383ab6cf6df11 Mon Sep 17 00:00:00 2001
From: Silvio Giebl <silvio.giebl@hivemq.com>
Date: Sun, 12 Jul 2020 20:02:44 +0200
Subject: [PATCH 10/10] Fixed display of nav-category

---
 _layouts/default.html | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/_layouts/default.html b/_layouts/default.html
index 8641d98..81bd3fc 100644
--- a/_layouts/default.html
+++ b/_layouts/default.html
@@ -55,7 +55,7 @@ layout: table_wrappers
           {% assign collection_value = collection_entry[1] %}
           {% assign collection = site[collection_key] %}
           {% if collection_value.nav_exclude != true %}
-            {% if doc_collections_size > 1 %}
+            {% if collections_size > 1 %}
               <div class="nav-category">{{ collection_value.name }}</div>
             {% endif %}
             {% include nav.html pages=collection %}