|
| 1 | +{% capture tocWorkspace %} |
| 2 | + {% comment %} |
| 3 | + Copyright (c) 2017 Vladimir "allejo" Jimenez |
| 4 | + |
| 5 | + Permission is hereby granted, free of charge, to any person |
| 6 | + obtaining a copy of this software and associated documentation |
| 7 | + files (the "Software"), to deal in the Software without |
| 8 | + restriction, including without limitation the rights to use, |
| 9 | + copy, modify, merge, publish, distribute, sublicense, and/or sell |
| 10 | + copies of the Software, and to permit persons to whom the |
| 11 | + Software is furnished to do so, subject to the following |
| 12 | + conditions: |
| 13 | + |
| 14 | + The above copyright notice and this permission notice shall be |
| 15 | + included in all copies or substantial portions of the Software. |
| 16 | + |
| 17 | + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, |
| 18 | + EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES |
| 19 | + OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND |
| 20 | + NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT |
| 21 | + HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, |
| 22 | + WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING |
| 23 | + FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR |
| 24 | + OTHER DEALINGS IN THE SOFTWARE. |
| 25 | + {% endcomment %} |
| 26 | + {% comment %} |
| 27 | + Version 1.2.0 |
| 28 | + https://github.com/allejo/jekyll-toc |
| 29 | + |
| 30 | + "...like all things liquid - where there's a will, and ~36 hours to spare, there's usually a/some way" ~jaybe |
| 31 | + |
| 32 | + Usage: |
| 33 | + {% include toc.html html=content sanitize=true class="inline_toc" id="my_toc" h_min=2 h_max=3 %} |
| 34 | + |
| 35 | + Parameters: |
| 36 | + * html (string) - the HTML of compiled markdown generated by kramdown in Jekyll |
| 37 | + |
| 38 | + Optional Parameters: |
| 39 | + * sanitize (bool) : false - when set to true, the headers will be stripped of any HTML in the TOC |
| 40 | + * class (string) : '' - a CSS class assigned to the TOC |
| 41 | + * id (string) : '' - an ID to assigned to the TOC |
| 42 | + * h_min (int) : 1 - the minimum TOC header level to use; any header lower than this value will be ignored |
| 43 | + * h_max (int) : 6 - the maximum TOC header level to use; any header greater than this value will be ignored |
| 44 | + * ordered (bool) : false - when set to true, an ordered list will be outputted instead of an unordered list |
| 45 | + * item_class (string) : '' - add custom class(es) for each list item; has support for '%level%' placeholder, which is the current heading level |
| 46 | + * submenu_class (string) : '' - add custom class(es) for each child group of headings; has support for '%level%' placeholder which is the current "submenu" heading level |
| 47 | + * base_url (string) : '' - add a base url to the TOC links for when your TOC is on another page than the actual content |
| 48 | + * anchor_class (string) : '' - add custom class(es) for each anchor element |
| 49 | + * skip_no_ids (bool) : false - skip headers that do not have an `id` attribute |
| 50 | + |
| 51 | + Output: |
| 52 | + An ordered or unordered list representing the table of contents of a markdown block. This snippet will only |
| 53 | + generate the table of contents and will NOT output the markdown given to it |
| 54 | + |
| 55 | + Modified: |
| 56 | + Functionality was modified for CollectionBuilder's context to allow site's creator to trigger a link to the technical credits in the side nav. Additions include lines 165-167 in this file, and the addition of an optional "credits" parameter in the include. credits=true will add "Technical" to the side nav with a link to the #technical anchor. credits=false or not including credits will remove "Technical" from the side nav. |
| 57 | + {% endcomment %} |
| 58 | + |
| 59 | + {% capture newline %} |
| 60 | + {% endcapture %} |
| 61 | + {% assign newline = newline | rstrip %} <!-- Remove the extra spacing but preserve the newline --> |
| 62 | + |
| 63 | + {% capture deprecation_warnings %}{% endcapture %} |
| 64 | + |
| 65 | + {% if include.baseurl %} |
| 66 | + {% capture deprecation_warnings %}{{ deprecation_warnings }}<!-- jekyll-toc :: "baseurl" has been deprecated, use "base_url" instead -->{{ newline }}{% endcapture %} |
| 67 | + {% endif %} |
| 68 | + |
| 69 | + {% if include.skipNoIDs %} |
| 70 | + {% capture deprecation_warnings %}{{ deprecation_warnings }}<!-- jekyll-toc :: "skipNoIDs" has been deprecated, use "skip_no_ids" instead -->{{ newline }}{% endcapture %} |
| 71 | + {% endif %} |
| 72 | + |
| 73 | + {% capture jekyll_toc %}{% endcapture %} |
| 74 | + {% assign orderedList = include.ordered | default: false %} |
| 75 | + {% assign baseURL = include.base_url | default: include.baseurl | default: '' %} |
| 76 | + {% assign skipNoIDs = include.skip_no_ids | default: include.skipNoIDs | default: false %} |
| 77 | + {% assign minHeader = include.h_min | default: 1 %} |
| 78 | + {% assign maxHeader = include.h_max | default: 6 %} |
| 79 | + {% assign nodes = include.html | strip | split: '<h' %} |
| 80 | + |
| 81 | + {% assign firstHeader = true %} |
| 82 | + {% assign currLevel = 0 %} |
| 83 | + {% assign lastLevel = 0 %} |
| 84 | + |
| 85 | + {% capture listModifier %}{% if orderedList %}ol{% else %}ul{% endif %}{% endcapture %} |
| 86 | + |
| 87 | + {% for node in nodes %} |
| 88 | + {% if node == "" %} |
| 89 | + {% continue %} |
| 90 | + {% endif %} |
| 91 | + |
| 92 | + {% assign currLevel = node | replace: '"', '' | slice: 0, 1 | times: 1 %} |
| 93 | + |
| 94 | + {% if currLevel < minHeader or currLevel > maxHeader %} |
| 95 | + {% continue %} |
| 96 | + {% endif %} |
| 97 | + |
| 98 | + {% assign _workspace = node | split: '</h' %} |
| 99 | + |
| 100 | + {% assign _idWorkspace = _workspace[0] | split: 'id="' %} |
| 101 | + {% assign _idWorkspace = _idWorkspace[1] | split: '"' %} |
| 102 | + {% assign htmlID = _idWorkspace[0] %} |
| 103 | + |
| 104 | + {% assign _classWorkspace = _workspace[0] | split: 'class="' %} |
| 105 | + {% assign _classWorkspace = _classWorkspace[1] | split: '"' %} |
| 106 | + {% assign htmlClass = _classWorkspace[0] %} |
| 107 | + |
| 108 | + {% if htmlClass contains "no_toc" %} |
| 109 | + {% continue %} |
| 110 | + {% endif %} |
| 111 | + |
| 112 | + {% if firstHeader %} |
| 113 | + {% assign minHeader = currLevel %} |
| 114 | + {% endif %} |
| 115 | + |
| 116 | + {% capture _hAttrToStrip %}{{ _workspace[0] | split: '>' | first }}>{% endcapture %} |
| 117 | + {% assign header = _workspace[0] | replace: _hAttrToStrip, '' %} |
| 118 | + |
| 119 | + {% if include.item_class and include.item_class != blank %} |
| 120 | + {% capture listItemClass %} class="{{ include.item_class | replace: '%level%', currLevel | split: '.' | join: ' ' }}"{% endcapture %} |
| 121 | + {% endif %} |
| 122 | + |
| 123 | + {% if include.submenu_class and include.submenu_class != blank %} |
| 124 | + {% assign subMenuLevel = currLevel | minus: 1 %} |
| 125 | + {% capture subMenuClass %} class="{{ include.submenu_class | replace: '%level%', subMenuLevel | split: '.' | join: ' ' }}"{% endcapture %} |
| 126 | + {% endif %} |
| 127 | + |
| 128 | + {% capture anchorBody %}{% if include.sanitize %}{{ header | strip_html }}{% else %}{{ header }}{% endif %}{% endcapture %} |
| 129 | + |
| 130 | + {% if htmlID %} |
| 131 | + {% capture anchorAttributes %} href="{% if baseURL %}{{ baseURL }}{% endif %}#{{ htmlID }}"{% endcapture %} |
| 132 | + |
| 133 | + {% if include.anchor_class %} |
| 134 | + {% capture anchorAttributes %}{{ anchorAttributes }} class="{{ include.anchor_class | split: '.' | join: ' ' }}"{% endcapture %} |
| 135 | + {% endif %} |
| 136 | + |
| 137 | + {% capture listItem %}<a{{ anchorAttributes }}>{{ anchorBody }}</a>{% endcapture %} |
| 138 | + {% elsif skipNoIDs == true %} |
| 139 | + {% continue %} |
| 140 | + {% else %} |
| 141 | + {% capture listItem %}{{ anchorBody }}{% endcapture %} |
| 142 | + {% endif %} |
| 143 | + |
| 144 | + {% if currLevel > lastLevel %} |
| 145 | + {% capture jekyll_toc %}{{ jekyll_toc }}<{{ listModifier }}{{ subMenuClass }}>{% endcapture %} |
| 146 | + {% elsif currLevel < lastLevel %} |
| 147 | + {% assign repeatCount = lastLevel | minus: currLevel %} |
| 148 | + |
| 149 | + {% for i in (1..repeatCount) %} |
| 150 | + {% capture jekyll_toc %}{{ jekyll_toc }}</li></{{ listModifier }}>{% endcapture %} |
| 151 | + {% endfor %} |
| 152 | + |
| 153 | + {% capture jekyll_toc %}{{ jekyll_toc }}</li>{% endcapture %} |
| 154 | + {% else %} |
| 155 | + {% capture jekyll_toc %}{{ jekyll_toc }}</li>{% endcapture %} |
| 156 | + {% endif %} |
| 157 | + |
| 158 | + {% capture jekyll_toc %}{{ jekyll_toc }}<li{{ listItemClass }}>{{ listItem }}{% endcapture %} |
| 159 | + |
| 160 | + {% assign lastLevel = currLevel %} |
| 161 | + {% assign firstHeader = false %} |
| 162 | + {% endfor %} |
| 163 | + |
| 164 | + {% assign repeatCount = minHeader | minus: 1 %} |
| 165 | + {% assign repeatCount = lastLevel | minus: repeatCount %} |
| 166 | + |
| 167 | + {% for i in (1..repeatCount) %} |
| 168 | + {% if i == repeatCount and include.credits == true %} |
| 169 | + {% capture jekyll_toc %}{{ jekyll_toc }}<li><a href="#technical">Technical</a>{% endcapture %} |
| 170 | + {% endif %} |
| 171 | + {% capture jekyll_toc %}{{ jekyll_toc }}</li></{{ listModifier }}>{% endcapture %} |
| 172 | + {% endfor %} |
| 173 | + |
| 174 | + {% if jekyll_toc != '' %} |
| 175 | + {% assign rootAttributes = '' %} |
| 176 | + {% if include.class and include.class != blank %} |
| 177 | + {% capture rootAttributes %} class="{{ include.class | split: '.' | join: ' ' }}"{% endcapture %} |
| 178 | + {% endif %} |
| 179 | + |
| 180 | + {% if include.id and include.id != blank %} |
| 181 | + {% capture rootAttributes %}{{ rootAttributes }} id="{{ include.id }}"{% endcapture %} |
| 182 | + {% endif %} |
| 183 | + |
| 184 | + {% if rootAttributes %} |
| 185 | + {% assign nodes = jekyll_toc | split: '>' %} |
| 186 | + {% capture jekyll_toc %}<{{ listModifier }}{{ rootAttributes }}>{{ nodes | shift | join: '>' }}>{% endcapture %} |
| 187 | + {% endif %} |
| 188 | + {% endif %} |
| 189 | +{% endcapture %}{% assign tocWorkspace = '' %}{{ deprecation_warnings }}{{ jekyll_toc -}} |
0 commit comments