Skip to content

Commit a59c6aa

Browse files
KronuzKronuz
committed
Added multi-level tree for sections
1 parent 12777a7 commit a59c6aa

File tree

17 files changed

+372
-113
lines changed

17 files changed

+372
-113
lines changed

‎_data/docs.yml‎

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
- title: Welcome
22
docs:
3-
- welcome
4-
- quickstart
5-
- installation
6-
- troubleshooting
3+
- url: welcome
4+
- url: quickstart
5+
- url: installation
6+
- url: troubleshooting
77

88
- title: Miscellaneous
99
docs:
10-
- faq
11-
- contributing
12-
- conduct
13-
- history
10+
- url: faq
11+
title: FAQ
12+
- url: contributing
13+
- url: conduct
14+
- url: history

‎_includes/blog/contents.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
<div class="unit one-fifth hide-on-mobiles">
22
<aside>
33
<ul>
4-
<li class="{% if page.title == 'Blog' %}current{% endif %}">
5-
<a href="{{ '/blog' | relative_url }}">All Articles</a>
4+
<li class="{% if '/blog/' == page.url %}current{% endif %}">
5+
<a href="{{ '/blog/' | relative_url }}">All Articles</a>
66
</li>
77
</ul>
88
<h4>Articles</h4>
99
<ul>
1010
{% for post in site.posts %}
11-
<li class="{% if page.title == post.title %}current{% endif %}">
11+
<li class="{% if post.url == page.url %}current{% endif %}">
1212
<a href="{{ post.url | relative_url }}">{{ post.title }}</a>
1313
</li>
1414
{% endfor %}

‎_includes/blog/contents_mobile.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
<div class="projects-nav-mobile unit whole show-on-mobiles">
22
<select onchange="if (this.value) window.location.href=this.value">
33
<option value="">Navigate the blog…</option>
4-
<option value="/blog/">Home</option>
4+
<option value="{{ '/blog/' | relative_url }}"{% if '/blog/' == page.url %} selected="selected"{% endif %}>Home</option>
55
<optgroup label="Articles">
66
{% for post in site.posts %}
7-
<option value="{{ post.url | relative_url }}">{{ post.title }}</option>
7+
<option value="{{ post.url | relative_url }}"{% if post.url == page.url %} selected="selected"{% endif %}>{{ post.title }}</option>
88
{% endfor %}
99
</optgroup>
1010
</select>

‎_includes/curl.html‎

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,24 @@
11
<div class="curl">
2-
{% assign _tmp = include.json | strip | remove_first: '```json' | remove_first: '```' | strip | newline_to_br | split: '<br />' %}
3-
{% capture _json %}{% for l in _tmp %}{% if forloop.first %}{% assign _first = l %}{% else %}{{ l }}{% endif %}{% endfor %}{% endcapture %}
4-
{% assign _method = _first | split: ' ' | first %}
5-
{% assign _url = _first | remove_first: _method | strip %}
6-
{% highlight json %}{{ _method }} {{ _url }} {{ _json }}{% endhighlight %}
7-
{% assign _json = _json | strip %}
8-
<button class="btn" data-clipboard-text="curl -H &apos;Content-Type: application/json&apos;{% if _json != blank %}{% assign _json_inspect = _json | inspect %}{% assign _size = _json_inspect.size | minus: 12 %} --data-binary &apos;{{ _json_inspect | slice: 6, _size | replace: '\&quot;': '&quot;' | replace: '&apos;', '\&apos;' | replace: '\n', '&#10;'' }}&apos;{% endif %} -X {{ _method }} &apos;localhost:8880{{ _url }}&apos;"><i class="fa fa-clipboard"></i></button>
2+
{% assign _headers = "" %}
3+
{% assign _body = "" %}
4+
{% assign _tmp = include.req | strip | newline_to_br | split: '<br />' %}
5+
{% for l in _tmp %}
6+
{% if forloop.first or forloop.last %}
7+
{% elsif forloop.index0 == 1 %}
8+
{% assign _url = l %}
9+
{% elsif _body == empty %}
10+
{% if l == blank %}
11+
{% assign _body = l %}
12+
{% else %}
13+
{% capture _headers %}{{ _headers }}{{ l }}{% endcapture %}
14+
{% endif %}
15+
{% else %}
16+
{% capture _body %}{{ _body }}{{ l }}{% endcapture %}
17+
{% endif %}
18+
{% endfor %}
19+
{% assign _method = _url | split: ' ' | first %}
20+
{% assign _url = _url | remove_first: _method | strip %}
21+
{% highlight json %}{{ _method }} {{ _url }}{{ _headers }}{% if _body != blank %}
22+
{{ _body | strip }}{% endif %}{% endhighlight %}
23+
<button class="btn" data-clipboard-text="curl{% if _headers == blank %}{% if _body != blank %} -H &apos;Content-Type: application/json&apos;{% endif %}{% else %}{% assign _tmp = _headers | strip | newline_to_br | strip_newlines | split: '<br />' %}{% for h in _tmp %} -H &apos;{% assign _header_inspect = h | inspect %}{% assign _size = _header_inspect.size | minus: 12 %}{{ _header_inspect | slice: 6, _size | replace: '\&quot;': '&quot;' | replace: '&apos;', '\&apos;' }}&apos;{% endfor %}{% endif %}{% if _body != blank %}{% assign _body_inspect = _body | strip | inspect %}{% assign _size = _body_inspect.size | minus: 12 %} --data-binary &apos;{{ _body_inspect | slice: 6, _size | replace: '\&quot;': '&quot;' | replace: '&apos;', '\&apos;' | replace: '\n', '&#10;'' }}&apos;{% endif %} -X {{ _method }} &apos;localhost:8880{{ _url }}&apos;"><i class="fa fa-clipboard"></i></button>
924
</div>

‎_includes/docs/contents.html‎

Lines changed: 44 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,53 @@
11
<div class="unit one-fifth hide-on-mobiles">
2-
<aside>
2+
<aside id="sidebar">
33
{% for section in site.data.docs %}
44
<h4>{{ section.title }}</h4>
55
<ul>
6-
{% for item in section.docs %}
7-
{% assign item_url = item | prepend:"/docs/" | append:"/" %}
8-
{% assign p = site.docs | where:"url", item_url | first %}
9-
<li class="{% if item_url == page.url %}current{% endif %}"><a href="{{ p.url | relative_url }}">{{ p.title }}</a></li>
6+
{% for l1 in section.docs %}
7+
{% assign l1_url = l1.url | prepend:"/docs/" | append:"/" %}
8+
{% assign l1_doc = site.docs | where:"url", l1_url | first %}
9+
{% if l1_doc %}
10+
<li class="{% if l1_doc.url == page.url %}current{% endif %}">
11+
<a href="{{ l1_doc.url | relative_url }}">{{ l1.title | default: l1_doc.title }}</a>
12+
<ul {% if l1_doc.url != page.url %}style="display:none"{% endif %}>
13+
{% for l2 in l1.docs %}
14+
{% assign l2_url = l2.url | prepend:"/docs/" | append:"/" %}
15+
{% assign l2_doc = site.docs | where:"url", l2_url | first %}
16+
{% if l2_doc %}
17+
<li class="{% if l2_doc.url == page.url %}current{% endif %}">
18+
<a href="{{ l2_doc.url | relative_url }}">{{ l2.title | default: l2_doc.title }}</a>
19+
<ul {% if l2_doc.url != page.url %}style="display:none"{% endif %}>
20+
{% for l3 in l2.docs %}
21+
{% assign l3_url = l3.url | prepend:"/docs/" | append:"/" %}
22+
{% assign l3_doc = site.docs | where:"url", l3_url | first %}
23+
{% if l3_doc %}
24+
<li class="{% if l3_doc.url == page.url %}current{% endif %}">
25+
<a href="{{ l3_doc.url | relative_url }}">{{ l3.title | default: l3_doc.title }}</a>
26+
</li>
27+
{% endif %}
28+
{% endfor %}
29+
</ul>
30+
</li>
31+
{% endif %}
32+
{% endfor %}
33+
</ul>
34+
</li>
35+
{% endif %}
1036
{% endfor %}
1137
</ul>
1238
{% endfor %}
1339
</aside>
40+
<script>
41+
var sidebar = document.getElementById('sidebar');
42+
var curr = sidebar.querySelectorAll('.current');
43+
for (var i = 0; i < curr.length; i++) {
44+
var p = curr[i].parentElement;
45+
while (p != sidebar) {
46+
if (p.tagName == 'UL') {
47+
p.style.display = 'block';
48+
}
49+
p = p.parentElement;
50+
}
51+
}
52+
</script>
1453
</div>

‎_includes/docs/contents_mobile.html‎

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,26 @@
33
<option value="">Navigate the docs…</option>
44
{% for section in site.data.docs %}
55
<optgroup label="{{ section.title }}">
6-
{% for item in section.docs %}
7-
{% assign item_url = item | prepend:"/docs/" | append:"/" %}
8-
{% assign doc = site.docs | where: "url", item_url | first %}
9-
<option value="{{ doc.url | relative_url }}">{{ doc.title }}</option>
6+
{% for l1 in section.docs %}
7+
{% assign l1_url = l1.url | prepend:"/docs/" | append:"/" %}
8+
{% assign l1_doc = site.docs | where: "url", l1_url | first %}
9+
{% if l1_doc %}
10+
<option value="{{ l1_doc.url | relative_url }}"{% if l1_doc.url == page.url %} selected="selected"{% endif %}>{{ l1.title | default:l1_doc.title }}</option>
11+
{% for l2 in l1.docs %}
12+
{% assign l2_url = l2.url | prepend:"/docs/" | append:"/" %}
13+
{% assign l2_doc = site.docs | where: "url", l2_url | first %}
14+
{% if l2_doc %}
15+
<option value="{{ l2_doc.url | relative_url }}"{% if l2_doc.url == page.url %} selected="selected"{% endif %}>&#160;&#160;{{ l2.title | default:l2_doc.title }}</option>
16+
{% for l3 in l2.docs %}
17+
{% assign l3_url = l3.url | prepend:"/docs/" | append:"/" %}
18+
{% assign l3_doc = site.docs | where: "url", l3_url | first %}
19+
{% if l3_doc %}
20+
<option value="{{ l3_doc.url | relative_url }}"{% if l3_doc.url == page.url %} selected="selected"{% endif %}>&#160;&#160;&#160;&#160;{{ l3.title | default:l3_doc.title }}</option>
21+
{% endif %}
22+
{% endfor %}
23+
{% endif %}
24+
{% endfor %}
25+
{% endif %}
1026
{% endfor %}
1127
</optgroup>
1228
{% endfor %}

‎_includes/docs/section_nav.html‎

Lines changed: 32 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,60 @@
11
{% comment %}
2-
Map grabs the doc sections, giving us an array of arrays. Join, flattens all
2+
Map grabs the docs sections, giving us an array of arrays. Join, flattens all
33
the items to a comma delimited string. Split turns it into an array again.
44
{% endcomment %}
5-
{% assign docs = site.data.docs | map: 'docs' | join: ',' | split: ',' %}
5+
{% assign _urls = "" %}
6+
{% for section in site.data.docs %}
7+
{% for l1 in section.docs %}
8+
{% assign l1_url = l1.url | prepend:"/docs/" | append:"/" %}
9+
{% assign l1_doc = site.docs | where:"url", l1_url | first %}
10+
{% if l1_doc %}
11+
{% capture _urls %}{{ _urls }},{{ l1_url }}{% endcapture %}
12+
{% for l2 in l1.docs %}
13+
{% assign l2_url = l2.url | prepend:"/docs/" | append:"/" %}
14+
{% assign l2_doc = site.docs | where:"url", l2_url | first %}
15+
{% if l2_doc %}
16+
{% capture _urls %}{{ _urls }},{{ l2_url }}{% endcapture %}
17+
{% for l3 in l2.docs %}
18+
{% assign l3_url = l3.url | prepend:"/docs/" | append:"/" %}
19+
{% assign l3_doc = site.docs | where:"url", l3_url | first %}
20+
{% if l3_doc %}
21+
{% capture _urls %}{{ _urls }},{{ l3_url }}{% endcapture %}
22+
{% endif %}
23+
{% endfor %}
24+
{% endif %}
25+
{% endfor %}
26+
{% endif %}
27+
{% endfor %}
28+
{% endfor %}
29+
{% assign docs = _urls | remove_first: ',' | split: ',' %}
630

731
{% comment %}
832
Because this is built for every page, lets find where we are in the ordered
933
document list by comparing url strings. Then if there's something previous or
1034
next, lets build a link to it.
1135
{% endcomment %}
1236

13-
{% for document in docs %}
14-
{% assign document_url = document | prepend:"/docs/" | append:"/" %}
15-
{% if document_url == page.url %}
37+
{% for doc_url in docs %}
38+
{% if doc_url == page.url %}
1639
<div class="section-nav">
1740
<div class="left align-right">
1841
{% if forloop.first %}
1942
<span class="prev disabled">Back</span>
2043
{% else %}
2144
{% assign prev = forloop.index0 | minus: 1 %}
22-
{% assign prev_url = docs[prev] | prepend:"/docs/" | append:"/" %}
45+
{% assign prev_url = docs[prev] %}
2346
{% assign prev_doc = site.docs | where: "url", prev_url | first %}
24-
<a href="{{ prev_url | relative_url }}" class="prev" title="{{ prev_doc.title }}">Back</a>
47+
<a href="{{ prev_doc.url | relative_url }}" class="prev" title="{{ prev_doc.title }}">Back</a>
2548
{% endif %}
2649
</div>
2750
<div class="right align-left">
2851
{% if forloop.last %}
2952
<span class="next disabled">Next</span>
3053
{% else %}
3154
{% assign next = forloop.index0 | plus: 1 %}
32-
{% assign next_url = docs[next] | prepend:"/docs/" | append:"/" %}
55+
{% assign next_url = docs[next] %}
3356
{% assign next_doc = site.docs | where: "url", next_url | first %}
34-
<a href="{{ next_url | relative_url }}" class="next" title="{{ next_doc.title }}">Next</a>
57+
<a href="{{ next_doc.url | relative_url }}" class="next" title="{{ next_doc.title }}">Next</a>
3558
{% endif %}
3659
</div>
3760
</div>

‎_includes/news/contents.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
<div class="unit one-fifth hide-on-mobiles">
22
<aside>
33
<ul>
4-
<li class="{% if page.title == 'News' %}current{% endif %}">
4+
<li class="{% if '/news/' == page.url %}current{% endif %}">
55
<a href="{{ '/news/' | relative_url }}">All News</a>
66
</li>
7-
<li class="{% if page.title == 'Releases' %}current{% endif %}">
7+
<li class="{% if '/news/releases/' == page.url %}current{% endif %}">
88
<a href="{{ '/news/releases/' | relative_url }}">{{ site.name }} Releases</a>
99
</li>
1010
</ul>
1111
<h4>Recent Releases</h4>
1212
<ul>
1313
{% for post in site.categories.release limit:5 %}
14-
<li class="{% if page.title == post.title %}current{% endif %}">
14+
<li class="{% if post.url == page.url %}current{% endif %}">
1515
<a href="{{ post.url | relative_url }}">Version {{ post.version }}</a>
1616
</li>
1717
{% endfor %}
@@ -23,7 +23,7 @@ <h4>Other News</h4>
2323
<ul>
2424
{% for post in site.posts %}
2525
{% unless post.categories contains 'release' %}
26-
<li class="{% if page.title == post.title %}current{% endif %}">
26+
<li class="{% if post.url == page.url %}current{% endif %}">
2727
<a href="{{ post.url | relative_url }}">{{ post.title }}</a>
2828
</li>
2929
{% endunless %}

‎_includes/news/contents_mobile.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
<div class="docs-nav-mobile unit whole show-on-mobiles">
22
<select onchange="if (this.value) window.location.href=this.value">
33
<option value="">Navigate the blog…</option>
4-
<option value="/news/">Home</option>
4+
<option value="{{ '/news/' | relative_url }}"{% if '/news/' == page.url %} selected="selected"{% endif %}>Home</option>
55
<optgroup label="News">
66
{% for post in site.posts %}
7-
<option value="{{ post.url | relative_url }}">{{ post.title }}</option>
7+
<option value="{{ post.url | relative_url }}"{% if post.url == page.url %} selected="selected"{% endif %}>{{ post.title }}</option>
88
{% endfor %}
99
</optgroup>
1010
</select>

‎_includes/projects/contents.html‎

Lines changed: 44 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<div class="unit one-fifth hide-on-mobiles">
2-
<aside>
2+
<aside id="sidebar">
33
<ul>
44
<li class="{% if page.title == 'Projects' %}current{% endif %}">
55
<a href="{{ '/projects' | relative_url }}">All Projects</a>
@@ -8,12 +8,51 @@
88
{% for section in site.data.projects %}
99
<h4>{{ section.title }}</h4>
1010
<ul>
11-
{% for item in section.projects %}
12-
{% assign item_url = item | prepend:"/projects/" | append:"/" %}
13-
{% assign p = site.projects | where:"url", item_url | first %}
14-
<li class="{% if item_url == page.url %}current{% endif %}"><a href="{{ p.url | relative_url }}">{{ p.title }}</a></li>
11+
{% for l1 in section.projects %}
12+
{% assign l1_url = l1.url | prepend:"/projects/" | append:"/" %}
13+
{% assign l1_doc = site.projects | where:"url", l1_url | first %}
14+
{% if l1_doc %}
15+
<li class="{% if l1_doc.url == page.url %}current{% endif %}">
16+
<a href="{{ l1_doc.url | relative_url }}">{{ l1.title | default: l1_doc.title }}</a>
17+
<ul {% if l1_doc.url != page.url %}style="display:none"{% endif %}>
18+
{% for l2 in l1.projects %}
19+
{% assign l2_url = l2.url | prepend:"/projects/" | append:"/" %}
20+
{% assign l2_doc = site.projects | where:"url", l2_url | first %}
21+
{% if l2_doc %}
22+
<li class="{% if l2_doc.url == page.url %}current{% endif %}">
23+
<a href="{{ l2_doc.url | relative_url }}">{{ l2.title | default: l2_doc.title }}</a>
24+
<ul {% if l2_doc.url != page.url %}style="display:none"{% endif %}>
25+
{% for l3 in l2.projects %}
26+
{% assign l3_url = l3.url | prepend:"/projects/" | append:"/" %}
27+
{% assign l3_doc = site.projects | where:"url", l3_url | first %}
28+
{% if l3_doc %}
29+
<li class="{% if l3_doc.url == page.url %}current{% endif %}">
30+
<a href="{{ l3_doc.url | relative_url }}">{{ l3.title | default: l3_doc.title }}</a>
31+
</li>
32+
{% endif %}
33+
{% endfor %}
34+
</ul>
35+
</li>
36+
{% endif %}
37+
{% endfor %}
38+
</ul>
39+
</li>
40+
{% endif %}
1541
{% endfor %}
1642
</ul>
1743
{% endfor %}
1844
</aside>
45+
<script>
46+
var sidebar = document.getElementById('sidebar');
47+
var curr = sidebar.querySelectorAll('.current');
48+
for (var i = 0; i < curr.length; i++) {
49+
var p = curr[i].parentElement;
50+
while (p != sidebar) {
51+
if (p.tagName == 'UL') {
52+
p.style.display = 'block';
53+
}
54+
p = p.parentElement;
55+
}
56+
}
57+
</script>
1958
</div>

0 commit comments

Comments
 (0)