jekyll-theme-gitbook 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e55032d1d46d8f8a1b6c58ab2a53e60d2aad1dd297f16c1bae5b83be0d309e8
-  data.tar.gz: 4d51893394120d5efeaf0b2284fa48a238fcf35c123fc862274e13edde266afa
+  metadata.gz: 0246e434f0a26049173d1b595ba1a0755b9cdcdf13fea1f399959c09c70aa24d
+  data.tar.gz: b236e07a84f4af0c16ab9a38c3764913d0afa01f42774464d8f0f4bcf9af2ca9
 SHA512:
-  metadata.gz: a4173c81205c974d250d58ac5bfa3cc7bce37f1ceb85296c7fae49ed41f2d19270a6f4047e94c1e0ea328b85ffeba3dfad82c38ffeed9eb2b6be26a29aad0fb0
-  data.tar.gz: e882279dad7d78c92f928c521c85afe102b6077b143e6a734dcafd3fafc588fb6bd55d30804cdffa683ae84866d1faba4308a41361b5ed74cdbe77ee4d64445d
+  metadata.gz: b74e123c0c5edcc54c8d36ec2222ab45adf9ecd7e83ccb220587b41591de4e938e3b629063689fd20a1877e012b0fd683176996214aa8a499b289bcc4a183f4f
+  data.tar.gz: 888013d432576776ee3587739ad3977249f1a46b8a282128f8ee6695a52bbcdc8b288e92bf9c0c66824c5ca1817740c779fb92aa495cf766240a450cdde74fee

data/README.md

@@ -34,7 +34,7 @@ This theme is designed to be highly configurable, whilst providing sensible defa
 If you are hosting your site on GitHub Pages then add the following line to your site's `_config.yml` file (as per [the documentation](https://docs.github.com/en/github/working-with-github-pages/adding-a-theme-to-your-github-pages-site-using-jekyll)):
 
 ```yaml
-remote_theme: "adamrehn/jekyll-theme-gitbook@v0.0.3"
+remote_theme: "adamrehn/jekyll-theme-gitbook@v0.0.4"
 ```
 
 ### Other hosts (e.g. GitLab Pages)
@@ -68,8 +68,17 @@ theme-settings:
   collection: "categories"
   
   
-  # Specifies whether navigation links should be generated for chapter index files that use the `chapter-index` layout (OPTIONAL, defaults to false)
-  indices: false
+  # Navigation menu settings (OPTIONAL, only needed if you want to override the defaults)
+  navigation:
+    
+    # Specifies whether navigation links should be generated for chapter index files that use the `chapter-index` layout (OPTIONAL, defaults to false)
+    indices: false
+    
+    # Specifies whether the navigation links for each chapter should be output as collapsible sections using HTML <detail> tags, with chapter headings as <summary> tags (OPTIONAL, defaults to false)
+    collapsible: false
+    
+    # When collapsible sections are enabled, specifies whether sections are collapsed by default (OPTIONAL, defaults to false)
+    collapsed: false
   
   
   # Copyright settings for the page footer (REQUIRED)
@@ -128,7 +137,12 @@ Each key in this structure serves a specific purpose:
 
 - `collection`: the theme uses a book metaphor to describe the structure of content. The site is broken down into a series of "chapters", each containing a series of pages. Of course, this naming convention does not make sense for all sites (for some sites, the "chapters" may in fact be referred to as sections or categories) and so the theme does not force you to adopt the name "chapters" in your filesystem structure. Instead, you can specify any [Jekyll collection](https://jekyllrb.com/docs/collections/) to act as your list of chapters, typically using one subdirectory per chapter to group pages. **You must specify the name of the Jekyll collection as a string value for this key.**
 
-- `indices`: by default, the theme only generates navigation links to each of the pages in each chapter, not to the chapter indices themselves. You can set this key to `true` if you would like to trigger the generation of chapter index navigation links, although note that links are only generated for chapters whose `index.html` files use the `chapter-index` layout and not for chapters whose index use the `chapter-redirect` layout. **This key is optional.**
+- `navigation`: this key groups settings for overriding the behaviour of the site's navigation links. **This key and all of its subkeys are optional:**
+    
+    - Subkey `indices`: by default, the theme only generates navigation links to each of the pages in each chapter, not to the chapter indices themselves. You can set this subkey to `true` if you would like to trigger the generation of chapter index navigation links, although note that links are only generated for chapters whose `index.html` files use the `chapter-index` layout and not for chapters whose index use the `chapter-redirect` layout.
+    
+    - Subkeys `collapsible` and `collapsed`: these subkeys allow you to make the sections of the navigation menu for each chapter collapsible, and specify whether they are collapsed or expanded by default, respectively.
+    
 
 - `copyright`: this key groups settings related to the copyright notice that appears in the footer of all pages. **This key and the `author` and `year` subkeys are required,** whilst the `license` subkey is optional.
 
@@ -247,7 +261,7 @@ The layout you choose will determine the site's behaviour when navigating to the
 
 If you choose to provide a chapter description then this will be displayed on the chapter's index page when using the `chapter-index` layout, and will also be displayed under the chapter's name if you generate a list of chapters with the `chapter-list.html` include (which is designed to be used on the front page of a site.)
 
-If you use the `chapter-index` layout for a chapter and the global setting `theme-settings.indices` is set to `true` then a link will be generated for the chapter index in the site's navigation sidebar.
+If you use the `chapter-index` layout for a chapter and the global setting `theme-settings.navigation.indices` is set to `true` then a link will be generated for the chapter index in the site's navigation sidebar.
 
 #### Content structure: site root
 

data/_includes/internal/navbar.html

@@ -9,17 +9,29 @@
 	{% assign pages = documents | where_exp: "page", "page.pagenum != null" | sort: "pagenum" %}
 	{% assign indices = documents | where_exp: "page", "page.pagenum == null" | sort: "chapnum" %}
 	
+	{% assign chapter_element = "p" %}
+	{% if site.theme-settings.navigation.collapsible == true %}
+		{% assign chapter_element = "summary" %}
+	{% endif %}
+	
 	{% for index in indices %}
-		<p class="chapter">{% if index.icon %}{% assign components = index.url | split: "/" %}<span class="icon icon-{{ components[-2] | escape }} {{ index.icon | escape }}"></span> {% endif %}{{ index.chapter | escape | replace: " ", "&nbsp;" }}</p>
+		
+		{% if site.theme-settings.navigation.collapsible == true %}<details{% unless site.theme-settings.navigation.collapsed == true %} open="true"{% endunless %}>{% endif %}
+		
+		<{{ chapter_element }} class="chapter">{% if index.icon %}{% assign components = index.url | split: "/" %}<span class="icon icon-{{ components[-2] | escape }} {{ index.icon | escape }}"></span> {% endif %}{{ index.chapter | escape }}</{{ chapter_element }}>
+		
 		<ul>
-		{% if site.theme-settings.indices == true and index.layout == "chapter-index" %}
+		{% if site.theme-settings.navigation.indices == true and index.layout == "chapter-index" %}
 			<li{% if index.url == page.url %} class="selected"{% endif %}><a href="{{ index.url | replace: "/index", "" | relative_url | uri_escape }}">Index</a></li>
 		{% endif %}
 		{% assign chapter_pages = pages | where: "chapter", index.chapter %}
 		{% for p in chapter_pages %}
-			<li{% if p.url == page.url %} class="selected"{% endif %}><a href="{{ p.url | relative_url | uri_escape }}">{{ p.title | escape | replace: " ", "&nbsp;" }}</a></li>
+			<li{% if p.url == page.url %} class="selected"{% endif %}><a href="{{ p.url | relative_url | uri_escape }}">{{ p.title | escape }}</a></li>
 		{% endfor %}
 		</ul>
+		
+		{% if site.theme-settings.navigation.collapsible == true %}</details>{% endif %}
+		
 	{% endfor %}
 	
 	{% include hooks/navbar-posthook.html %}

data/_sass/_content.scss

@@ -96,6 +96,10 @@ nav .chapter, .contents .heading, article .chapter, .prev-next a .label, .prev-n
 	margin: 0;
 }
 
+nav .chapter, nav ul li {
+	max-width: 100%;
+}
+
 nav ul + .chapter {
 	margin-top: 2rem;
 }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-gitbook
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Adam Rehn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-17 00:00:00.000000000 Z
+date: 2022-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -126,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.23
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: Gem-based Jekyll theme for documentation sites, inspired by GitBook's visual