programming-pages 0.5.9 → 0.5.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e752d8b47207a58900615d051daa8b1772c624c1880f0f2d335246a83bfc7dc
-  data.tar.gz: 52204a18698b7b3140505f5d7c2f1ac16f86cbf27b0f6e20974ab259c8b33a84
+  metadata.gz: 5f8b6a72ea89a58403a987fcb1f1bf533a398315653ef6d1584348a387cc7dac
+  data.tar.gz: d58a72b9f1a89d2623a40171b36a68413d2a4d41c36970d50a870088c280038a
 SHA512:
-  metadata.gz: 8bb5d22d7c3e2ae585e71a64a9c2c22944f134324a17988289f25e10e7c19e4a12a8b32f2f3b0a867e07868a7ba8b0f7c5c55206533cfb6d58e5e07f1cda81db
-  data.tar.gz: 4c414c5d6cee588a1cf4bf3ebbf99cff271bf0f5233e8296f95a1e84cead70ab93815db115576d5201405e31d9af148c428af7feca7eb3726c74304ef6bacb82
+  metadata.gz: 8090fe3e5ad1856673d62c91d9049f3c780149a9a47040a6afe47c2b74f2c33f9ee9a4307fd6f17574e9972b7f1d0d548d8095c73d34e7aca9fa2f6f27b4d81c
+  data.tar.gz: 80197eecfea2bd9fd38b11c02ab7bbe31f752133223872d98161341ec8c3fffcc07984cc97d8739f0f504f85e154ab896131e72df7a19e26cd1771d9c3fa9446

data/_includes/elements/attribution.html

@@ -20,7 +20,7 @@
 
 <tr>
   <td class="smaller text">
-  <strong>programming pages</strong> template v{{ layout.theme_version }} (<a href="{{ layout.theme_url }}" title="a documentation template for GitHub Pages">{{ layout.theme_url }}</a>)
+  <strong>programming pages</strong> theme v{{ layout.theme_version }} (<a href="{{ layout.theme_url }}" title="a jekyll theme for publishing code documentation to GitHub pages">{{ layout.theme_url }}</a>)
   </td>
 </tr>
 

data/_includes/elements/indices.html

@@ -38,10 +38,12 @@
 <h4 class="ui header">{{ collection.title }}</h4>
 <div class="ui inverted link list">
 {% assign doc_list = collection.docs %}
+
+{% unless collection.ignore-page-order %}
 {% assign ordered_doc_list = '' | split: '' %}
 
 {%- comment %}
-for guides, we want to support user-defined ordering, but not require it in every guide.
+for collection pages, we want to support user-defined ordering, but not require it on every page.
 
 this means we have to create our own file tree, keeping children with parents as we re-sort
 the collection list from its default alphabetical order into user order, and for that,
@@ -86,7 +88,7 @@ so our strategy is to:
 {%- comment %} first, calculate max_depth as deepest level index {% endcomment -%}
 {% assign max_depth = 0 %}
 {% for doc in doc_list %}
-  {% assign depth = doc.path | split:'/' | size | minus:2 %} {%- comment %} minus one to convert from length to index, minus two to ignore root collection directory (_guides/) {% endcomment -%}
+  {% assign depth = doc.path | split:'/' | size | minus:2 %} {%- comment %} minus one to convert from length to index, minus two to ignore root collection directory (e.g. _guides/) {% endcomment -%}
   {% if depth > max_depth %}{% assign max_depth = depth %}{% endif %}
 {% endfor %}
 
@@ -199,27 +201,13 @@ so our strategy is to:
 {%- endfor -%}
 
 {% assign doc_list = ordered_doc_list %}
+{% endunless %}
 
-{% for doc in doc_list %}
-  {% capture link %}{{ doc.title }}{% endcapture %}
-  {% capture url %}{{ doc.url }}#/{{ collection.label | downcase }}/{% endcapture %}
-  {% capture item_class %}{% if doc.title == page.title %}active {% endif %}item{% endcapture %}
-  {% case doc.layout %}
-    {% when 'package' %}
-      {% capture link %}{% include icon.liquid id='folder-outline' %} {% include package_shortener.liquid package=doc.module %}{% endcapture %}
-    {% when 'type' %}
-      {% capture pkg %}{{ doc.module }}.{{ doc.name }}{% endcapture %}
-      {% capture link %}{% include package_shortener.liquid package=pkg %}{% endcapture %}
-    {% when 'page' %}
-      {% assign path_bits = doc.relative_path | split: '.' | first | split: '/' %}
-      {% assign n = path_bits.size | minus: 2 %}
-      {% if n > 3 %}{% assign n = 3 %}{% endif %}
-      {% capture indent %}{% for i in (1..n) %}&ensp;{% endfor %}{% endcapture %}
-      {% capture link %}{{ indent }}{{ doc.title }}{% endcapture %}
-  {% endcase %}
-  <a class="very tight smaller text {{ item_class }}" href="{{ site.baseurl }}{{ url }}">{{ link }}</a>
-{% endfor %}
+{%- comment %} delegate to extension point for actual rendering of link list {% endcomment -%}
+{% include render_indices.liquid doc_list=doc_list collection_label=collection.title page_title=page.title %}
 
+<br>
+<br>
 </div>
 </div>
 {% endfor %}

data/_includes/page_root.liquid

@@ -1,7 +1,7 @@
 {%- comment -%}
 
 page_root
-  extracts first component of page url
+  extracts the first component of a page url
 
 params:
   page=<page-object>

data/_includes/render_indices.liquid

@@ -0,0 +1,25 @@
+{%- comment -%}
+
+render_indices
+  creates the individual links in the sidebar
+  - pages, layouts, and guide-indexes are indented when parented
+
+params:
+  doc_list=<array of document objects to create links for>
+  collection_label=<name of collection the docs belong to>
+  page_title=<title of the calling page>
+
+{%- endcomment -%}
+{% for doc in include.doc_list %}
+  {% capture link %}{{ doc.title }}{% endcapture %}
+  {% capture url %}{{ doc.url }}#/{{ include.collection_label | downcase }}/{% endcapture %}
+  {% capture item_class %}{% if doc.title == include.page_title %}active {% endif %}item{% endcapture %}
+  {% if doc.layout == 'page' or doc.layout == 'layout' or doc.layout == 'guide-index' %}
+    {% assign path_bits = doc.relative_path | split: '.' | first | split: '/' %}
+    {% assign n = path_bits.size | minus: 2 %}
+    {% if n > 3 %}{% assign n = 3 %}{% endif %}
+    {% capture indent %}{% for i in (1..n) %}&ensp;{% endfor %}{% endcapture %}
+    {% capture link %}{{ indent }}{{ doc.title }}{% endcapture %}
+  {% endif %}
+  <a class="very tight smaller text {{ item_class }}" href="{{ site.baseurl }}{{ url }}">{{ link }}</a>
+{% endfor %}

data/_layouts/page.html

@@ -1,6 +1,6 @@
 ---
 layout: base
-theme_version: 0.5.9
+theme_version: 0.5.10
 theme_url: https://github.com/pixeldroid/programming-pages
 ---
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: programming-pages
 version: !ruby/object:Gem::Version
-  version: 0.5.9
+  version: 0.5.10
 platform: ruby
 authors:
 - pixeldroid
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-03 00:00:00.000000000 Z
+date: 2018-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: github-pages
@@ -73,6 +73,7 @@ files:
 - _includes/ordered_child_list.liquid
 - _includes/package_shortener.liquid
 - _includes/page_root.liquid
+- _includes/render_indices.liquid
 - _includes/scripts/example.js
 - _includes/scripts/help.js
 - _includes/scripts/indices.js