just-the-docs 0.2.5 → 0.3.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (46) hide show
  1. checksums.yaml +5 -5
  2. data/README.md +2 -2
  3. data/_includes/css/custom.scss.liquid +1 -0
  4. data/_includes/css/just-the-docs.scss.liquid +7 -0
  5. data/_includes/head.html +19 -13
  6. data/_includes/head_custom.html +0 -0
  7. data/_includes/js/custom.js +0 -0
  8. data/_includes/nav.html +55 -44
  9. data/_includes/title.html +5 -0
  10. data/_includes/vendor/anchor_headings.html +100 -0
  11. data/_layouts/default.html +146 -55
  12. data/_layouts/table_wrappers.html +7 -0
  13. data/_layouts/vendor/compress.html +10 -0
  14. data/_sass/base.scss +16 -18
  15. data/_sass/buttons.scss +1 -1
  16. data/_sass/code.scss +211 -72
  17. data/_sass/color_schemes/dark.scss +4 -1
  18. data/_sass/color_schemes/light.scss +0 -0
  19. data/_sass/content.scss +80 -1
  20. data/_sass/custom/custom.scss +0 -120
  21. data/_sass/labels.scss +5 -4
  22. data/_sass/layout.scss +118 -62
  23. data/_sass/modules.scss +20 -0
  24. data/_sass/navigation.scss +125 -77
  25. data/_sass/print.scss +40 -0
  26. data/_sass/search.scss +263 -56
  27. data/_sass/support/_functions.scss +2 -3
  28. data/_sass/support/_variables.scss +27 -22
  29. data/_sass/support/mixins/_layout.scss +1 -3
  30. data/_sass/support/mixins/_typography.scss +6 -1
  31. data/_sass/tables.scss +13 -33
  32. data/_sass/typography.scss +9 -7
  33. data/_sass/utilities/_layout.scss +74 -17
  34. data/_sass/utilities/_lists.scss +7 -1
  35. data/_sass/utilities/_spacing.scss +69 -25
  36. data/assets/css/just-the-docs-dark.scss +3 -0
  37. data/assets/css/just-the-docs-default.scss +8 -0
  38. data/assets/css/just-the-docs-light.scss +3 -0
  39. data/assets/js/just-the-docs.js +425 -130
  40. data/assets/js/vendor/lunr.min.js +3 -3
  41. data/assets/js/zzzz-search-data.json +58 -0
  42. data/lib/tasks/search.rake +54 -9
  43. metadata +43 -26
  44. data/assets/css/dark-mode-preview.scss +0 -41
  45. data/assets/css/just-the-docs.scss +0 -44
  46. data/assets/js/search-data.json +0 -12
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 84277d0c372ae947b9e9c10f2d2d63f9c05820de
4
- data.tar.gz: fa1e641fa9d22cbae138bcba7f547a1e47ae2aa7
2
+ SHA256:
3
+ metadata.gz: e2844428b424cfc181383ae6082de0b423671060a6d1dbda09e6109a4fd84606
4
+ data.tar.gz: add4d5ded3df2fd68ccd217bb016a1a59a3565353cdced79e26348cd8ae573b1
5
5
  SHA512:
6
- metadata.gz: a167ec6ffb810f68a57decbd31ef1da71c59ed5fd56729baa97aea5397538a64eea3f820f16d9c944c55ec917a5d5fb10523756d42b020558a9b29c9a0ff3aae
7
- data.tar.gz: 121b99ff601c34d78c1a52a3b89b6bfbdd1e8622b752063de6fafe9a7fe6727f1c41cdab85407e45f42fa062be80939468578e93aca4cce305816856f3f42f85
6
+ metadata.gz: c070b6335d791caa5ab2553dda3e36af8e1bbf17a1bf7808fe4794e8acbc89328c577b104096a0e8eca59e02084e023c72685378450c7a85c0d6ce9d4f6313a7
7
+ data.tar.gz: d7028baf344ede0a68e9f7274fdb4a99fca6d9485b997145a3d915a2eda001565530d8711abc25a7d3db1c71065d932d685e118b3d66218477804c972189ab6b
data/README.md CHANGED
@@ -1,10 +1,10 @@
1
1
  <p align="right">
2
- <a href="https://badge.fury.io/rb/just-the-docs"><img src="https://badge.fury.io/rb/just-the-docs.svg" alt="Gem version"></a> <a href="https://travis-ci.com/pmarsceill/just-the-docs"><img src="https://travis-ci.com/pmarsceill/just-the-docs.svg?branch=master" alt="Build status"></a>
2
+ <a href="https://badge.fury.io/rb/just-the-docs"><img src="https://badge.fury.io/rb/just-the-docs.svg" alt="Gem version"></a> <a href="https://github.com/pmarsceill/just-the-docs/actions?query=workflow%3A%22Master+branch+CI%22"><img src="https://github.com/pmarsceill/just-the-docs/workflows/Master%20branch%20CI/badge.svg" alt="Build status"></a>
3
3
  </p>
4
4
  <br><br>
5
5
  <p align="center">
6
6
  <h1 align="center">Just the Docs</h1>
7
- <p align="center">A modern, high customizable, responsive Jekyll theme for documentation with built-in search.<br>Easily hosted on GitHub Pages with few dependencies.</p>
7
+ <p align="center">A modern, highly customizable, and responsive Jekyll theme for documentation with built-in search.<br>Easily hosted on GitHub Pages with few dependencies.</p>
8
8
  <p align="center"><strong><a href="https://pmarsceill.github.io/just-the-docs/">See it in action!</a></strong></p>
9
9
  <br><br><br>
10
10
  </p>
@@ -0,0 +1 @@
1
+ @import "./custom/custom";
@@ -0,0 +1,7 @@
1
+ {% if site.logo %}
2
+ $logo: "{{ site.logo | absolute_url }}";
3
+ {% endif %}
4
+ @import "./support/support";
5
+ @import "./color_schemes/{{ include.color_scheme }}";
6
+ @import "./modules";
7
+ {% include css/custom.scss.liquid %}
@@ -2,33 +2,39 @@
2
2
  <meta charset="UTF-8">
3
3
  <meta http-equiv="X-UA-Compatible" content="IE=Edge">
4
4
 
5
- {% if site.plugins.jekyll-seo == nil %}
5
+ {% unless site.plugins contains "jekyll-seo-tag" %}
6
6
  <title>{{ page.title }} - {{ site.title }}</title>
7
7
 
8
8
  {% if page.description %}
9
- <meta name="Description" content="{{ page.description }}">
9
+ <meta name="Description" content="{{ page.description }}">
10
10
  {% endif %}
11
- {% endif %}
11
+ {% endunless %}
12
12
 
13
- <link rel="shortcut icon" href="{{ "favicon.ico" | absolute_url }}" type="image/x-icon">
13
+ <link rel="shortcut icon" href="{{ 'favicon.ico' | absolute_url }}" type="image/x-icon">
14
14
 
15
- <link rel="stylesheet" href="{{ "/assets/css/just-the-docs.css" | absolute_url }}">
15
+ <link rel="stylesheet" href="{{ '/assets/css/just-the-docs-default.css' | absolute_url }}">
16
16
 
17
17
  {% if site.ga_tracking != nil %}
18
+ <script async src="https://www.googletagmanager.com/gtag/js?id={{ site.ga_tracking }}"></script>
18
19
  <script>
19
- window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)};ga.l=+new Date;
20
- ga('create', '{{ site.ga_tracking }}', '{{ site.url }}');
21
- ga('send', 'pageview');
20
+ window.dataLayer = window.dataLayer || [];
21
+ function gtag(){dataLayer.push(arguments);}
22
+ gtag('js', new Date());
23
+
24
+ gtag('config', '{{ site.ga_tracking }}'{% unless site.ga_tracking_anonymize_ip == nil %}, { 'anonymize_ip': true }{% endunless %});
22
25
  </script>
23
- <script async src="https://www.google-analytics.com/analytics.js"></script>
26
+
24
27
  {% endif %}
25
28
 
26
- {% if site.search_enabled != nil %}
27
- <script type="text/javascript" src="{{ "/assets/js/vendor/lunr.min.js" | absolute_url }}"></script>
29
+ {% if site.search_enabled != false %}
30
+ <script type="text/javascript" src="{{ '/assets/js/vendor/lunr.min.js' | absolute_url }}"></script>
28
31
  {% endif %}
29
- <script type="text/javascript" src="{{ "/assets/js/just-the-docs.js" | absolute_url }}"></script>
32
+ <script type="text/javascript" src="{{ '/assets/js/just-the-docs.js' | absolute_url }}"></script>
30
33
 
31
34
  <meta name="viewport" content="width=device-width, initial-scale=1">
32
35
 
33
- {% seo %}
36
+ {% seo %}
37
+
38
+ {% include head_custom.html %}
39
+
34
40
  </head>
File without changes
File without changes
@@ -1,44 +1,55 @@
1
- <nav role="navigation" aria-label="Main navigation">
2
- <ul class="navigation-list">
3
- {% assign pages_list = site.html_pages | sort:"nav_order" %}
4
- {% for node in pages_list %}
5
- {% unless node.nav_exclude %}
6
- {% if node.parent == nil %}
7
- <li class="navigation-list-item{% if page.url == node.url or page.parent == node.title or page.grand_parent == node.title %} active{% endif %}">
8
- {% if page.parent == node.title or page.grand_parent == node.title %}
9
- {% assign first_level_url = node.url | absolute_url %}
10
- {% endif %}
11
- <a href="{{ node.url | absolute_url }}" class="navigation-list-link{% if page.url == node.url %} active{% endif %}">{{ node.title }}</a>
12
- {% if node.has_children %}
13
- {% assign children_list = site.html_pages | sort:"nav_order" %}
14
- <ul class="navigation-list-child-list ">
15
- {% for child in children_list %}
16
- {% if child.parent == node.title %}
17
- <li class="navigation-list-item {% if page.url == child.url or page.parent == child.title %} active{% endif %}">
18
- {% if page.url == child.url or page.parent == child.title %}
19
- {% assign second_level_url = child.url | absolute_url %}
20
- {% endif %}
21
- <a href="{{ child.url | absolute_url }}" class="navigation-list-link{% if page.url == child.url %} active{% endif %}">{{ child.title }}</a>
22
- {% if child.has_children %}
23
- {% assign grand_children_list = site.html_pages | sort:"nav_order" %}
24
- <ul class="navigation-list-child-list">
25
- {% for grand_child in grand_children_list %}
26
- {% if grand_child.parent == child.title %}
27
- <li class="navigation-list-item {% if page.url == grand_child.url %} active{% endif %}">
28
- <a href="{{ grand_child.url | absolute_url }}" class="navigation-list-link{% if page.url == grand_child.url %} active{% endif %}">{{ grand_child.title }}</a>
29
- </li>
30
- {% endif %}
31
- {% endfor %}
32
- </ul>
33
- {% endif %}
34
- </li>
35
- {% endif %}
36
- {% endfor %}
37
- </ul>
38
- {% endif %}
39
- </li>
40
- {% endif %}
41
- {% endunless %}
42
- {% endfor %}
43
- </ul>
44
- </nav>
1
+ <ul class="nav-list">
2
+ {%- assign ordered_pages_list = site.html_pages | where_exp:"item", "item.nav_order != nil" -%}
3
+ {%- assign unordered_pages_list = site.html_pages | where_exp:"item", "item.nav_order == nil" -%}
4
+ {%- if site.nav_sort == 'case_insensitive' -%}
5
+ {%- assign sorted_ordered_pages_list = ordered_pages_list | sort_natural:"nav_order" -%}
6
+ {%- assign sorted_unordered_pages_list = unordered_pages_list | sort_natural:"title" -%}
7
+ {%- else -%}
8
+ {%- assign sorted_ordered_pages_list = ordered_pages_list | sort:"nav_order" -%}
9
+ {%- assign sorted_unordered_pages_list = unordered_pages_list | sort:"title" -%}
10
+ {%- endif -%}
11
+ {%- assign pages_list = sorted_ordered_pages_list | concat: sorted_unordered_pages_list -%}
12
+ {%- for node in pages_list -%}
13
+ {%- unless node.nav_exclude -%}
14
+ {%- if node.parent == nil and node.title -%}
15
+ <li class="nav-list-item{% if page.url == node.url or page.parent == node.title or page.grand_parent == node.title %} active{% endif %}">
16
+ {%- if page.parent == node.title or page.grand_parent == node.title -%}
17
+ {%- assign first_level_url = node.url | absolute_url -%}
18
+ {%- endif -%}
19
+ {%- if node.has_children -%}
20
+ <a href="#" class="nav-list-expander"><svg viewBox="0 0 24 24"><use xlink:href="#svg-arrow-right"></use></svg></a>
21
+ {%- endif -%}
22
+ <a href="{{ node.url | absolute_url }}" class="nav-list-link{% if page.url == node.url %} active{% endif %}">{{ node.title }}</a>
23
+ {%- if node.has_children -%}
24
+ {%- assign children_list = pages_list | where: "parent", node.title -%}
25
+ <ul class="nav-list ">
26
+ {%- for child in children_list -%}
27
+ {%- unless child.nav_exclude -%}
28
+ <li class="nav-list-item {% if page.url == child.url or page.parent == child.title %} active{% endif %}">
29
+ {%- if page.url == child.url or page.parent == child.title -%}
30
+ {%- assign second_level_url = child.url | absolute_url -%}
31
+ {%- endif -%}
32
+ {%- if child.has_children -%}
33
+ <a href="#" class="nav-list-expander"><svg viewBox="0 0 24 24"><use xlink:href="#svg-arrow-right"></use></svg></a>
34
+ {%- endif -%}
35
+ <a href="{{ child.url | absolute_url }}" class="nav-list-link{% if page.url == child.url %} active{% endif %}">{{ child.title }}</a>
36
+ {%- if child.has_children -%}
37
+ {%- assign grand_children_list = pages_list | where: "parent", child.title | where: "grand_parent", node.title -%}
38
+ <ul class="nav-list">
39
+ {%- for grand_child in grand_children_list -%}
40
+ <li class="nav-list-item {% if page.url == grand_child.url %} active{% endif %}">
41
+ <a href="{{ grand_child.url | absolute_url }}" class="nav-list-link{% if page.url == grand_child.url %} active{% endif %}">{{ grand_child.title }}</a>
42
+ </li>
43
+ {%- endfor -%}
44
+ </ul>
45
+ {%- endif -%}
46
+ </li>
47
+ {%- endunless -%}
48
+ {%- endfor -%}
49
+ </ul>
50
+ {%- endif -%}
51
+ </li>
52
+ {%- endif -%}
53
+ {%- endunless -%}
54
+ {%- endfor -%}
55
+ </ul>
@@ -0,0 +1,5 @@
1
+ {% if site.logo %}
2
+ <div class="site-logo"></div>
3
+ {% else %}
4
+ {{ site.title }}
5
+ {% endif %}
@@ -0,0 +1,100 @@
1
+ {% capture headingsWorkspace %}
2
+ {% comment %}
3
+ Version 1.0.3
4
+ https://github.com/allejo/jekyll-anchor-headings
5
+
6
+ "Be the pull request you wish to see in the world." ~Ben Balter
7
+
8
+ Usage:
9
+ {% include anchor_headings.html html=content %}
10
+
11
+ Parameters:
12
+ * html (string) - the HTML of compiled markdown generated by kramdown in Jekyll
13
+
14
+ Optional Parameters:
15
+ * beforeHeading (bool) : false - Set to true if the anchor should be placed _before_ the heading's content
16
+ * anchorBody (string) : '' - The content that will be placed inside the anchor; the `%heading%` placeholder is available
17
+ * anchorClass (string) : '' - The class(es) that will be used for each anchor. Separate multiple classes with a space
18
+ * anchorTitle (string) : '' - The `title` attribute that will be used for anchors
19
+ * h_min (int) : 1 - The minimum header level to build an anchor for; any header lower than this value will be ignored
20
+ * h_max (int) : 6 - The maximum header level to build an anchor for; any header greater than this value will be ignored
21
+ * bodyPrefix (string) : '' - Anything that should be inserted inside of the heading tag _before_ its anchor and content
22
+ * bodySuffix (string) : '' - Anything that should be inserted inside of the heading tag _after_ its anchor and content
23
+
24
+ Output:
25
+ The original HTML with the addition of anchors inside of all of the h1-h6 headings.
26
+ {% endcomment %}
27
+
28
+ {% assign minHeader = include.h_min | default: 1 %}
29
+ {% assign maxHeader = include.h_max | default: 6 %}
30
+ {% assign beforeHeading = include.beforeHeading %}
31
+ {% assign nodes = include.html | split: '<h' %}
32
+
33
+ {% capture edited_headings %}{% endcapture %}
34
+
35
+ {% for _node in nodes %}
36
+ {% capture node %}{{ _node | strip }}{% endcapture %}
37
+
38
+ {% if node == "" %}
39
+ {% continue %}
40
+ {% endif %}
41
+
42
+ {% assign nextChar = node | replace: '"', '' | strip | slice: 0, 1 %}
43
+ {% assign headerLevel = nextChar | times: 1 %}
44
+
45
+ <!-- If the level is cast to 0, it means it's not a h1-h6 tag, so let's try to fix it -->
46
+ {% if headerLevel == 0 %}
47
+ {% if nextChar != '<' and nextChar != '' %}
48
+ {% capture node %}<h{{ node }}{% endcapture %}
49
+ {% endif %}
50
+
51
+ {% capture edited_headings %}{{ edited_headings }}{{ node }}{% endcapture %}
52
+ {% continue %}
53
+ {% endif %}
54
+
55
+ {% assign _workspace = node | split: '</h' %}
56
+ {% assign _idWorkspace = _workspace[0] | split: 'id="' %}
57
+ {% assign _idWorkspace = _idWorkspace[1] | split: '"' %}
58
+ {% assign html_id = _idWorkspace[0] %}
59
+
60
+ {% capture _hAttrToStrip %}{{ _workspace[0] | split: '>' | first }}>{% endcapture %}
61
+ {% assign header = _workspace[0] | replace: _hAttrToStrip, '' %}
62
+
63
+ <!-- Build the anchor to inject for our heading -->
64
+ {% capture anchor %}{% endcapture %}
65
+
66
+ {% if html_id and headerLevel >= minHeader and headerLevel <= maxHeader %}
67
+ {% capture anchor %}href="#{{ html_id}}"{% endcapture %}
68
+
69
+ {% if include.anchorClass %}
70
+ {% capture anchor %}{{ anchor }} class="{{ include.anchorClass }}"{% endcapture %}
71
+ {% endif %}
72
+
73
+ {% if include.anchorTitle %}
74
+ {% capture anchor %}{{ anchor }} title="{{ include.anchorTitle | replace: '%heading%', header }}"{% endcapture %}
75
+ {% endif %}
76
+
77
+ {% capture anchor %}<a {{ anchor }}>{{ include.anchorBody | replace: '%heading%', header | default: '' }}</a>{% endcapture %}
78
+
79
+ <!-- In order to prevent adding extra space after a heading, we'll let the 'anchor' value contain it -->
80
+ {% if beforeHeading %}
81
+ {% capture anchor %}{{ anchor }} {% endcapture %}
82
+ {% else %}
83
+ {% capture anchor %} {{ anchor }}{% endcapture %}
84
+ {% endif %}
85
+ {% endif %}
86
+
87
+ {% capture new_heading %}
88
+ <h{{ _hAttrToStrip }}
89
+ {{ include.bodyPrefix }}
90
+ {% if beforeHeading %}
91
+ {{ anchor }}{{ header }}
92
+ {% else %}
93
+ {{ header }}{{ anchor }}
94
+ {% endif %}
95
+ {{ include.bodySuffix }}
96
+ </h{{ _workspace | last }}
97
+ {% endcapture %}
98
+ {% capture edited_headings %}{{ edited_headings }}{{ new_heading }}{% endcapture %}
99
+ {% endfor %}
100
+ {% endcapture %}{% assign headingsWorkspace = '' %}{{ edited_headings | strip }}
@@ -1,78 +1,169 @@
1
+ ---
2
+ layout: table_wrappers
3
+ ---
4
+
1
5
  <!DOCTYPE html>
2
6
 
3
- <html lang="{{ site.lang | default: "en-US" }}">
7
+ <html lang="{{ site.lang | default: 'en-US' }}">
4
8
  {% include head.html %}
5
9
  <body>
10
+ <svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
11
+ <symbol id="svg-link" viewBox="0 0 24 24">
12
+ <title>Link</title>
13
+ <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-link">
14
+ <path d="M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71"></path><path d="M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71"></path>
15
+ </svg>
16
+ </symbol>
17
+ <symbol id="svg-search" viewBox="0 0 24 24">
18
+ <title>Search</title>
19
+ <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-search">
20
+ <circle cx="11" cy="11" r="8"></circle><line x1="21" y1="21" x2="16.65" y2="16.65"></line>
21
+ </svg>
22
+ </symbol>
23
+ <symbol id="svg-menu" viewBox="0 0 24 24">
24
+ <title>Menu</title>
25
+ <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-menu">
26
+ <line x1="3" y1="12" x2="21" y2="12"></line><line x1="3" y1="6" x2="21" y2="6"></line><line x1="3" y1="18" x2="21" y2="18"></line>
27
+ </svg>
28
+ </symbol>
29
+ <symbol id="svg-arrow-right" viewBox="0 0 24 24">
30
+ <title>Expand</title>
31
+ <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-chevron-right">
32
+ <polyline points="9 18 15 12 9 6"></polyline>
33
+ </svg>
34
+ </symbol>
35
+ <symbol id="svg-doc" viewBox="0 0 24 24">
36
+ <title>Document</title>
37
+ <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-file">
38
+ <path d="M13 2H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2V9z"></path><polyline points="13 2 13 9 20 9"></polyline>
39
+ </svg>
40
+ </symbol>
41
+ </svg>
6
42
 
7
- <div class="page-wrap">
8
- <div class="side-bar">
9
- <a href="{{ site.url }}{{ site.baseurl }}" class="site-title fs-6 lh-tight">{{ site.title }}</a>
10
- <span class="fs-3"><button class="js-main-nav-trigger navigation-list-toggle btn btn-outline" type="button" data-text-toggle="Hide">Menu</button></span>
11
- <div class="navigation main-nav js-main-nav">
12
- {% include nav.html %}
13
- </div>
14
- <footer role="contentinfo" class="site-footer">
15
- <p class="text-small text-grey-dk-000 mb-0">This site uses <a href="https://github.com/pmarsceill/just-the-docs">Just the Docs</a>, a documentation theme for Jekyll.</p>
16
- </footer>
43
+ <div class="side-bar">
44
+ <div class="site-header">
45
+ <a href="{{ '/' | absolute_url }}" class="site-title lh-tight">{% include title.html %}</a>
46
+ <a href="#" id="menu-button" class="site-button">
47
+ <svg viewBox="0 0 24 24" class="icon"><use xlink:href="#svg-menu"></use></svg>
48
+ </a>
17
49
  </div>
18
- <div class="main-content-wrap js-main-content" tabindex="0">
19
- <div class="page-header">
20
- <div class="main-content">
21
- {% if site.search_enabled != nil %}
22
- <div class="search js-search">
23
- <div class="search-input-wrap">
24
- <input type="text" class="js-search-input search-input" tabindex="0" placeholder="Search {{ site.title }}" aria-label="Search {{ site.title }}" autocomplete="off">
25
- <svg width="14" height="14" viewBox="0 0 28 28" xmlns="http://www.w3.org/2000/svg" class="search-icon"><title>Search</title><g fill-rule="nonzero"><path d="M17.332 20.735c-5.537 0-10-4.6-10-10.247 0-5.646 4.463-10.247 10-10.247 5.536 0 10 4.601 10 10.247s-4.464 10.247-10 10.247zm0-4c3.3 0 6-2.783 6-6.247 0-3.463-2.7-6.247-6-6.247s-6 2.784-6 6.247c0 3.464 2.7 6.247 6 6.247z"/><path d="M11.672 13.791L.192 25.271 3.02 28.1 14.5 16.62z"/></g></svg>
26
- </div>
27
- <div class="js-search-results search-results-wrap"></div>
50
+ <nav role="navigation" aria-label="Main" id="site-nav" class="site-nav">
51
+ {% include nav.html %}
52
+ </nav>
53
+ <footer class="site-footer">
54
+ This site uses <a href="https://github.com/pmarsceill/just-the-docs">Just the Docs</a>, a documentation theme for Jekyll.
55
+ </footer>
56
+ </div>
57
+ <div class="main" id="top">
58
+ <div id="main-header" class="main-header">
59
+ {% if site.search_enabled != false %}
60
+ <div class="search">
61
+ <div class="search-input-wrap">
62
+ <input type="text" id="search-input" class="search-input" tabindex="0" placeholder="Search {{ site.title }}" aria-label="Search {{ site.title }}" autocomplete="off">
63
+ <label for="search-input" class="search-label"><svg viewBox="0 0 24 24" class="search-icon"><use xlink:href="#svg-search"></use></svg></label>
28
64
  </div>
29
- {% endif %}
30
- {% if site.aux_links != nil %}
31
- <ul class="list-style-none text-small mt-md-1 mb-md-1 pb-4 pb-md-0 js-aux-nav aux-nav">
32
- {% for link in site.aux_links %}
33
- <li class="d-inline-block my-0{% unless forloop.last %} mr-2{% endunless %}"><a href="{{ link.last }}">{{ link.first }}</a></li>
34
- {% endfor %}
35
- </ul>
36
- {% endif %}
65
+ <div id="search-results" class="search-results"></div>
37
66
  </div>
38
- </div>
39
- <div class="main-content">
40
- {% unless page.url == "/" %}
41
- {% if page.parent %}
42
- <nav class="breadcrumb-nav">
43
- <ol class="breadcrumb-nav-list">
44
- {% if page.grand_parent %}
45
- <li class="breadcrumb-nav-list-item"><a href="{{ first_level_url }}">{{ page.grand_parent }}</a></li>
46
- <li class="breadcrumb-nav-list-item"><a href="{{ second_level_url }}">{{ page.parent }}</a></li>
47
- {% else %}
48
- <li class="breadcrumb-nav-list-item"><a href="{{ first_level_url }}">{{ page.parent }}</a></li>
49
- {% endif %}
50
- <li class="breadcrumb-nav-list-item"><span>{{ page.title }}</span></li>
51
- </ol>
52
- </nav>
53
- {% endif %}
54
- {% endunless %}
55
- <div id="main-content" class="page-content" role="main">
67
+ {% endif %}
68
+ {% if site.aux_links %}
69
+ <nav aria-label="Auxiliary" class="aux-nav">
70
+ <ul class="aux-nav-list">
71
+ {% for link in site.aux_links %}
72
+ <li class="aux-nav-list-item">
73
+ <a href="{{ link.last }}" class="site-button"
74
+ {% if site.aux_links_new_tab %}
75
+ target="_blank" rel="noopener noreferrer"
76
+ {% endif %}
77
+ >
78
+ {{ link.first }}
79
+ </a>
80
+ </li>
81
+ {% endfor %}
82
+ </ul>
83
+ </nav>
84
+ {% endif %}
85
+ </div>
86
+ <div id="main-content-wrap" class="main-content-wrap">
87
+ {% unless page.url == "/" %}
88
+ {% if page.parent %}
89
+ <nav aria-label="Breadcrumb" class="breadcrumb-nav">
90
+ <ol class="breadcrumb-nav-list">
91
+ {% if page.grand_parent %}
92
+ <li class="breadcrumb-nav-list-item"><a href="{{ first_level_url }}">{{ page.grand_parent }}</a></li>
93
+ <li class="breadcrumb-nav-list-item"><a href="{{ second_level_url }}">{{ page.parent }}</a></li>
94
+ {% else %}
95
+ <li class="breadcrumb-nav-list-item"><a href="{{ first_level_url }}">{{ page.parent }}</a></li>
96
+ {% endif %}
97
+ <li class="breadcrumb-nav-list-item"><span>{{ page.title }}</span></li>
98
+ </ol>
99
+ </nav>
100
+ {% endif %}
101
+ {% endunless %}
102
+ <div id="main-content" class="main-content" role="main">
103
+ {% if site.heading_anchors != false %}
104
+ {% include vendor/anchor_headings.html html=content beforeHeading="true" anchorBody="<svg viewBox=\"0 0 16 16\" aria-hidden=\"true\"><use xlink:href=\"#svg-link\"></use></svg>" anchorClass="anchor-heading" %}
105
+ {% else %}
56
106
  {{ content }}
107
+ {% endif %}
57
108
 
58
- {% if page.has_children == true and page.has_toc != false %}
109
+ {% if page.has_children == true and page.has_toc != false %}
59
110
  <hr>
60
111
  <h2 class="text-delta">Table of contents</h2>
61
- {% assign children_list = site.pages | sort:"nav_order" %}
62
112
  <ul>
113
+ {%- assign children_list = pages_list | where: "parent", page.title | where: "grand_parent", page.parent -%}
63
114
  {% for child in children_list %}
64
- {% if child.parent == page.title and child.title != page.title %}
65
115
  <li>
66
- <a href="{{ child.url | absolute_url }}">{{ child.title }}</a>
116
+ <a href="{{ child.url | absolute_url }}">{{ child.title }}</a>{% if child.summary %} - {{ child.summary }}{% endif %}
67
117
  </li>
68
- {% endif %}
69
118
  {% endfor %}
70
119
  </ul>
71
- {% endif %}
72
- </div>
120
+ {% endif %}
121
+
122
+ {% if site.footer_content != nil or site.last_edit_timestamp or site.gh_edit_link %}
123
+ <hr>
124
+ <footer>
125
+ {% if site.back_to_top %}
126
+ <p><a href="#top" id="back-to-top">{{ site.back_to_top_text }}</a></p>
127
+ {% endif %}
128
+ {% if site.footer_content != nil %}
129
+ <p class="text-small text-grey-dk-000 mb-0">{{ site.footer_content }}</p>
130
+ {% endif %}
131
+
132
+ {% if site.last_edit_timestamp or site.gh_edit_link %}
133
+ <div class="d-flex mt-2">
134
+ {% if site.last_edit_timestamp and site.last_edit_time_format and page.last_modified_date %}
135
+ <p class="text-small text-grey-dk-000 mb-0 mr-2">
136
+ Page last modified: <span class="d-inline-block">{{ page.last_modified_date | date: site.last_edit_time_format }}</span>.
137
+ </p>
138
+ {% endif %}
139
+ {% if
140
+ site.gh_edit_link and
141
+ site.gh_edit_link_text and
142
+ site.gh_edit_repository and
143
+ site.gh_edit_branch and
144
+ site.gh_edit_view_mode
145
+ %}
146
+ <p class="text-small text-grey-dk-000 mb-0">
147
+ <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>
148
+ </p>
149
+ {% endif %}
150
+ </div>
151
+ {% endif %}
152
+ </footer>
153
+ {% endif %}
154
+
73
155
  </div>
74
156
  </div>
75
- </div>
76
157
 
158
+ {% if site.search_enabled != false %}
159
+ {% if site.search.button %}
160
+ <a href="#" id="search-button" class="search-button">
161
+ <svg viewBox="0 0 24 24" class="icon"><use xlink:href="#svg-search"></use></svg>
162
+ </a>
163
+ {% endif %}
164
+
165
+ <div class="search-overlay"></div>
166
+ {% endif %}
167
+ </div>
77
168
  </body>
78
169
  </html>