1  {% capture tocWorkspace %}
 2      {% comment %}
 3          Version 1.0.10
 4            https://github.com/allejo/jekyll-toc
 5  
 6          "...like all things liquid - where there's a will, and ~36 hours to spare, there's usually a/some way" ~jaybe
 7  
 8          Usage:
 9              {% include toc.html html=content sanitize=true class="inline_toc" id="my_toc" h_min=2 h_max=3 %}
10  
11          Parameters:
12              * html         (string) - the HTML of compiled markdown generated by kramdown in Jekyll
13  
14          Optional Parameters:
15              * sanitize     (bool)   : false  - when set to true, the headers will be stripped of any HTML in the TOC
16              * class        (string) :   ''   - a CSS class assigned to the TOC
17              * id           (string) :   ''   - an ID to assigned to the TOC
18              * h_min        (int)    :   1    - the minimum TOC header level to use; any header lower than this value will be ignored
19              * h_max        (int)    :   6    - the maximum TOC header level to use; any header greater than this value will be ignored
20              * ordered      (bool)   : false  - when set to true, an ordered list will be outputted instead of an unordered list
21              * item_class   (string) :   ''   - add custom class(es) for each list item; has support for '%level%' placeholder, which is the current heading level
22              * baseurl      (string) :   ''   - add a base url to the TOC links for when your TOC is on another page than the actual content
23              * anchor_class (string) :   ''   - add custom class(es) for each anchor element
24  
25          Output:
26              An ordered or unordered list representing the table of contents of a markdown block. This snippet will only
27              generate the table of contents and will NOT output the markdown given to it
28      {% endcomment %}
29  
30      {% capture my_toc %}{% endcapture %}
31      {% assign orderedList = include.ordered | default: false %}
32      {% assign minHeader = include.h_min | default: 1 %}
33      {% assign maxHeader = include.h_max | default: 6 %}
34      {% assign nodes = include.html | split: '<h' %}
35      {% assign firstHeader = true %}
36  
37      {% capture listModifier %}{% if orderedList %}1.{% else %}-{% endif %}{% endcapture %}
38  
39      {% for node in nodes %}
40          {% if node == "" %}
41              {% continue %}
42          {% endif %}
43  
44          {% assign headerLevel = node | replace: '"', '' | slice: 0, 1 | times: 1 %}
45  
46          {% if headerLevel < minHeader or headerLevel > maxHeader %}
47              {% continue %}
48          {% endif %}
49  
50          {% if firstHeader %}
51              {% assign firstHeader = false %}
52              {% assign minHeader = headerLevel %}
53          {% endif %}
54  
55          {% assign indentAmount = headerLevel | minus: minHeader %}
56          {% assign _workspace = node | split: '</h' %}
57  
58          {% assign _idWorkspace = _workspace[0] | split: 'id="' %}
59          {% assign _idWorkspace = _idWorkspace[1] | split: '"' %}
60          {% assign html_id = _idWorkspace[0] %}
61  
62          {% assign _classWorkspace = _workspace[0] | split: 'class="' %}
63          {% assign _classWorkspace = _classWorkspace[1] | split: '"' %}
64          {% assign html_class = _classWorkspace[0] %}
65  
66          {% if html_class contains "no_toc" %}
67              {% continue %}
68          {% endif %}
69  
70          {% capture _hAttrToStrip %}{{ _workspace[0] | split: '>' | first }}>{% endcapture %}
71          {% assign header = _workspace[0] | replace: _hAttrToStrip, '' %}
72  
73          {% assign space = '' %}
74          {% for i in (1..indentAmount) %}
75              {% assign space = space | prepend: '    ' %}
76          {% endfor %}
77  
78          {% if include.item_class and include.item_class != blank %}
79              {% capture listItemClass %}{:.{{ include.item_class | replace: '%level%', headerLevel }}}{% endcapture %}
80          {% endif %}
81  
82          {% capture heading_body %}{% if include.sanitize %}{{ header | strip_html }}{% else %}{{ header }}{% endif %}{% endcapture %}
83          {% capture my_toc %}{{ my_toc }}
84  {{ space }}{{ listModifier }} {{ listItemClass }} [{{ heading_body | replace: "|", "\|" }}]({% if include.baseurl %}{{ include.baseurl }}{% endif %}#{{ html_id }}){% if include.anchor_class %}{:.{{ include.anchor_class }}}{% endif %}{% endcapture %}
85      {% endfor %}
86  
87      {% if include.class and include.class != blank %}
88          {% capture my_toc %}{:.{{ include.class }}}
89  {{ my_toc | lstrip }}{% endcapture %}
90      {% endif %}
91  
92      {% if include.id %}
93          {% capture my_toc %}{: #{{ include.id }}}
94  {{ my_toc | lstrip }}{% endcapture %}
95      {% endif %}
96  {% endcapture %}{% assign tocWorkspace = '' %}{{ my_toc | markdownify | strip }}