|
| 1 | +{% capture headingsWorkspace %} |
| 2 | + {% comment %} |
| 3 | + Version 1.0.4 |
| 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 | + * anchorAttrs (string) : '' - Any custom HTML attributes that will be added to the `<a>` tag; you may NOT use `href`, `class` or `title` |
| 17 | + * anchorBody (string) : '' - The content that will be placed inside the anchor; the `%heading%` placeholder is available |
| 18 | + * anchorClass (string) : '' - The class(es) that will be used for each anchor. Separate multiple classes with a space |
| 19 | + * anchorTitle (string) : '' - The `title` attribute that will be used for anchors |
| 20 | + * h_min (int) : 1 - The minimum header level to build an anchor for; any header lower than this value will be ignored |
| 21 | + * h_max (int) : 6 - The maximum header level to build an anchor for; any header greater than this value will be ignored |
| 22 | + * bodyPrefix (string) : '' - Anything that should be inserted inside of the heading tag _before_ its anchor and content |
| 23 | + * bodySuffix (string) : '' - Anything that should be inserted inside of the heading tag _after_ its anchor and content |
| 24 | + |
| 25 | + Output: |
| 26 | + The original HTML with the addition of anchors inside of all of the h1-h6 headings. |
| 27 | + {% endcomment %} |
| 28 | + |
| 29 | + {% assign minHeader = include.h_min | default: 1 %} |
| 30 | + {% assign maxHeader = include.h_max | default: 6 %} |
| 31 | + {% assign beforeHeading = include.beforeHeading %} |
| 32 | + {% assign nodes = include.html | split: '<h' %} |
| 33 | + |
| 34 | + {% capture edited_headings %}{% endcapture %} |
| 35 | + |
| 36 | + {% for _node in nodes %} |
| 37 | + {% capture node %}{{ _node | strip }}{% endcapture %} |
| 38 | + |
| 39 | + {% if node == "" %} |
| 40 | + {% continue %} |
| 41 | + {% endif %} |
| 42 | + |
| 43 | + {% assign nextChar = node | replace: '"', '' | strip | slice: 0, 1 %} |
| 44 | + {% assign headerLevel = nextChar | times: 1 %} |
| 45 | + |
| 46 | + <!-- If the level is cast to 0, it means it's not a h1-h6 tag, so let's try to fix it --> |
| 47 | + {% if headerLevel == 0 %} |
| 48 | + {% if nextChar != '<' and nextChar != '' %} |
| 49 | + {% capture node %}<h{{ node }}{% endcapture %} |
| 50 | + {% endif %} |
| 51 | + |
| 52 | + {% capture edited_headings %}{{ edited_headings }}{{ node }}{% endcapture %} |
| 53 | + {% continue %} |
| 54 | + {% endif %} |
| 55 | + |
| 56 | + {% assign _workspace = node | split: '</h' %} |
| 57 | + {% assign _idWorkspace = _workspace[0] | split: 'id="' %} |
| 58 | + {% assign _idWorkspace = _idWorkspace[1] | split: '"' %} |
| 59 | + {% assign html_id = _idWorkspace[0] %} |
| 60 | + |
| 61 | + {% capture _hAttrToStrip %}{{ _workspace[0] | split: '>' | first }}>{% endcapture %} |
| 62 | + {% assign header = _workspace[0] | replace: _hAttrToStrip, '' %} |
| 63 | + |
| 64 | + <!-- Build the anchor to inject for our heading --> |
| 65 | + {% capture anchor %}{% endcapture %} |
| 66 | + |
| 67 | + {% if html_id and headerLevel >= minHeader and headerLevel <= maxHeader %} |
| 68 | + {% capture anchor %}href="#{{ html_id }}"{% endcapture %} |
| 69 | + |
| 70 | + {% if include.anchorClass %} |
| 71 | + {% capture anchor %}{{ anchor }} class="{{ include.anchorClass }}"{% endcapture %} |
| 72 | + {% endif %} |
| 73 | + |
| 74 | + {% if include.anchorTitle %} |
| 75 | + {% capture anchor %}{{ anchor }} title="{{ include.anchorTitle | replace: '%heading%', header }}"{% endcapture %} |
| 76 | + {% endif %} |
| 77 | + |
| 78 | + {% if include.anchorAttrs %} |
| 79 | + {% capture anchor %}{{ anchor }} {{ include.anchorAttrs }}{% endcapture %} |
| 80 | + {% endif %} |
| 81 | + |
| 82 | + {% capture anchor %}<a {{ anchor }}>{{ include.anchorBody | replace: '%heading%', header | default: '' }}</a>{% endcapture %} |
| 83 | + |
| 84 | + <!-- In order to prevent adding extra space after a heading, we'll let the 'anchor' value contain it --> |
| 85 | + {% if beforeHeading %} |
| 86 | + {% capture anchor %}{{ anchor }} {% endcapture %} |
| 87 | + {% else %} |
| 88 | + {% capture anchor %} {{ anchor }}{% endcapture %} |
| 89 | + {% endif %} |
| 90 | + {% endif %} |
| 91 | + |
| 92 | + {% capture new_heading %} |
| 93 | + <h{{ _hAttrToStrip }} |
| 94 | + {{ include.bodyPrefix }} |
| 95 | + {% if beforeHeading %} |
| 96 | + {{ anchor }}{{ header }} |
| 97 | + {% else %} |
| 98 | + {{ header }}{{ anchor }} |
| 99 | + {% endif %} |
| 100 | + {{ include.bodySuffix }} |
| 101 | + </h{{ _workspace | last }} |
| 102 | + {% endcapture %} |
| 103 | + {% capture edited_headings %}{{ edited_headings }}{{ new_heading }}{% endcapture %} |
| 104 | + {% endfor %} |
| 105 | +{% endcapture %}{% assign headingsWorkspace = '' %}{{ edited_headings | strip }} |
0 commit comments