From 3667d26c0d175ab4c7b5fe2edb6985c9f30d98c3 Mon Sep 17 00:00:00 2001 From: Valentin Lorentz Date: Fri, 26 Mar 2021 21:57:49 +0100 Subject: [PATCH 1/4] Generate header ids and anchors without Javascript Uses https://github.com/allejo/jekyll-anchor-headings instead of https://www.npmjs.com/package/anchor-js As far as I can tell, it only breaks one anchor: https://ircv3.net/charter#project-resources-contribution will become https://ircv3.net/charter#project-resources--contribution because kramdown does not generate ids in exactly the same way as anchor.js Pros of this change: * Works in browsers without JS * Less code overall (and the code is readable instead of being minified) * No need for `{% include anchors.html %}` at the bottom of every page Cons: * Breaks that URL * A little more work on the server side --- _config.yml | 2 +- _includes/anchor_headings.html | 152 +++++++++++++++++++++++++++++++++ _includes/anchors.html | 8 -- _irc/index.md | 3 - _layouts/default.html | 2 +- _layouts/page.html | 2 - _layouts/spec.html | 2 - charter.md | 2 - conduct.md | 2 - css/style.sass | 6 ++ faq.md | 2 - js/anchor.min.js | 6 -- registry.md | 2 - 13 files changed, 160 insertions(+), 31 deletions(-) create mode 100644 _includes/anchor_headings.html delete mode 100644 _includes/anchors.html delete mode 100644 js/anchor.min.js diff --git a/_config.yml b/_config.yml index 5244f603..8145c442 100644 --- a/_config.yml +++ b/_config.yml @@ -5,7 +5,7 @@ url: https://ircv3.net repository: ircv3/ircv3.github.io kramdown: input: GFM - auto_ids: false + auto_ids: true include: - _redirects exclude: diff --git a/_includes/anchor_headings.html b/_includes/anchor_headings.html new file mode 100644 index 00000000..be83180d --- /dev/null +++ b/_includes/anchor_headings.html @@ -0,0 +1,152 @@ +{% capture headingsWorkspace %} + {% comment %} + Copyright (c) 2018 Vladimir "allejo" Jimenez + + Permission is hereby granted, free of charge, to any person + obtaining a copy of this software and associated documentation + files (the "Software"), to deal in the Software without + restriction, including without limitation the rights to use, + copy, modify, merge, publish, distribute, sublicense, and/or sell + copies of the Software, and to permit persons to whom the + Software is furnished to do so, subject to the following + conditions: + + The above copyright notice and this permission notice shall be + included in all copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES + OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT + HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, + WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR + OTHER DEALINGS IN THE SOFTWARE. + {% endcomment %} + {% comment %} + Version 1.0.9 + https://github.com/allejo/jekyll-anchor-headings + + "Be the pull request you wish to see in the world." ~Ben Balter + + Usage: + {% include anchor_headings.html html=content anchorBody="#" %} + + Parameters: + * html (string) - the HTML of compiled markdown generated by kramdown in Jekyll + + Optional Parameters: + * beforeHeading (bool) : false - Set to true if the anchor should be placed _before_ the heading's content + * headerAttrs (string) : '' - Any custom HTML attributes that will be added to the heading tag; you may NOT use `id`; + the `%heading%` and `%html_id%` placeholders are available + * anchorAttrs (string) : '' - Any custom HTML attributes that will be added to the `` tag; you may NOT use `href`, `class` or `title`; + the `%heading%` and `%html_id%` placeholders are available + * anchorBody (string) : '' - The content that will be placed inside the anchor; the `%heading%` placeholder is available + * anchorClass (string) : '' - The class(es) that will be used for each anchor. Separate multiple classes with a space + * anchorTitle (string) : '' - The `title` attribute that will be used for anchors + * h_min (int) : 1 - The minimum header level to build an anchor for; any header lower than this value will be ignored + * h_max (int) : 6 - The maximum header level to build an anchor for; any header greater than this value will be ignored + * bodyPrefix (string) : '' - Anything that should be inserted inside of the heading tag _before_ its anchor and content + * bodySuffix (string) : '' - Anything that should be inserted inside of the heading tag _after_ its anchor and content + + Output: + The original HTML with the addition of anchors inside of all of the h1-h6 headings. + {% endcomment %} + + {% assign minHeader = include.h_min | default: 1 %} + {% assign maxHeader = include.h_max | default: 6 %} + {% assign beforeHeading = include.beforeHeading %} + {% assign nodes = include.html | split: ' + {% if headerLevel == 0 %} + + {% assign firstChunk = node | split: '>' | first %} + + + {% unless firstChunk contains '<' %} + {% capture node %}{% endcapture %} + {% assign _workspace = node | split: _closingTag %} + {% assign _idWorkspace = _workspace[0] | split: 'id="' %} + {% assign _idWorkspace = _idWorkspace[1] | split: '"' %} + {% assign html_id = _idWorkspace[0] %} + + {% capture _hAttrToStrip %}{{ _workspace[0] | split: '>' | first }}>{% endcapture %} + {% assign header = _workspace[0] | replace: _hAttrToStrip, '' %} + + + {% capture anchor %}{% endcapture %} + + {% if html_id and headerLevel >= minHeader and headerLevel <= maxHeader %} + {% assign escaped_header = header | strip_html %} + + {% if include.headerAttrs %} + {% capture _hAttrToStrip %}{{ _hAttrToStrip | split: '>' | first }} {{ include.headerAttrs | replace: '%heading%', escaped_header | replace: '%html_id%', html_id }}>{% endcapture %} + {% endif %} + + {% capture anchor %}href="#{{ html_id }}"{% endcapture %} + + {% if include.anchorClass %} + {% capture anchor %}{{ anchor }} class="{{ include.anchorClass }}"{% endcapture %} + {% endif %} + + {% if include.anchorTitle %} + {% capture anchor %}{{ anchor }} title="{{ include.anchorTitle | replace: '%heading%', escaped_header }}"{% endcapture %} + {% endif %} + + {% if include.anchorAttrs %} + {% capture anchor %}{{ anchor }} {{ include.anchorAttrs | replace: '%heading%', escaped_header | replace: '%html_id%', html_id }}{% endcapture %} + {% endif %} + + {% capture anchor %}{{ include.anchorBody | replace: '%heading%', escaped_header | default: '' }}{% endcapture %} + + + {% if beforeHeading %} + {% capture anchor %}{{ anchor }} {% endcapture %} + {% else %} + {% capture anchor %} {{ anchor }}{% endcapture %} + {% endif %} + {% endif %} + + {% capture new_heading %} + + {% endcapture %} + + + {% assign chunkCount = _workspace | size %} + {% if chunkCount > 1 %} + {% capture new_heading %}{{ new_heading }}{{ _workspace | last }}{% endcapture %} + {% endif %} + + {% capture edited_headings %}{{ edited_headings }}{{ new_heading }}{% endcapture %} + {% endfor %} +{% endcapture %}{% assign headingsWorkspace = '' %}{{ edited_headings | strip }} diff --git a/_includes/anchors.html b/_includes/anchors.html deleted file mode 100644 index a716d766..00000000 --- a/_includes/anchors.html +++ /dev/null @@ -1,8 +0,0 @@ - - \ No newline at end of file diff --git a/_irc/index.md b/_irc/index.md index 072a8b3e..ff516656 100644 --- a/_irc/index.md +++ b/_irc/index.md @@ -396,6 +396,3 @@ The [`tls` spec]({{site.baseurl}}/specs/extensions/tls-3.1.html) is still available for reference. It describes how the `STARTTLS` command works, as well as how connection registration is changed by the introduction of this capability. - - -{% include anchors.html %} diff --git a/_layouts/default.html b/_layouts/default.html index 0170bbde..1494e17b 100644 --- a/_layouts/default.html +++ b/_layouts/default.html @@ -40,7 +40,7 @@ {% capture mdph %}{{ page.page-header | markdownify }}{% endcapture %} {% include pageheader.html content=mdph %} {% endif %} - {{ content }} + {% include anchor_headings.html html=content anchorBody="#" %}