Accessible anchor links for your headings

read time: 46 min

Html Table of contents

Check out the sum symbol ∑F = ma ❮prev * next❯ in css \00276E

Contents with wrapper. Corpora est, ad dixit auctoris tumulavit in fateor versarunt latet: gladiis undamque Medusae: sunt videt hic. Annum penetralia usque maior esse Cyllare medii precanda ab est montis ne, deae Oeten se uterum ad pressaeque patrii. Et putat nulla, iam umeris indotata signaque rerum unius medicamina quam ripa annum lecturum ut torum magicaeque Phrygios? Victus arma, malo curas temptabimus illi oborto undis pharetra! Caelo risi cecidere quo ferrum: solis tacitus patrii, in lato.

This following is MathJax

MathJax is an open-source JavaScript display engine for LaTeX, MathML, and AsciiMath notation that works in all modern browsers.
It is included in the head element in a script tag. Check it out at MathJax

Euler's identity $$e^{i\pi}+1=0$$ is a beautiful formula in $\RR^2$.

When \(a \ne 0\), there are two solutions to \(ax^2 + bx + c = 0\) and they are

$$x = {-b \pm \sqrt{b^2-4ac} \over 2a}.$$

$$c = \pm \sqrt{a^2 + b^2}$$

$c = \pm \sqrt{a^2 + b^2}$

$$ \int_{-N}^{N} e^x, dx$$

The sum is \( \sum_{\color{blue}n=0}^{\color{red}\infty} a_n x^n\)

<script type="text/x-mathjax-config">
MathJax.Ajax.config.path["a11y"] = "https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/extensions/a11y";
MathJax.Hub.Config({
  // ...your other configuration options...
  extensions: ["[a11y]/accessibility-menu.js"]
  menuSettings: {
    collapsible: true,
    autocollapse: true,
    explorer: true
  }
});
</script>
<script type="text/javascript" id="MathJax-script" async
    src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js">
</script>

A logging example:

Every page has a page object available in the template which includes data like input and output file paths, the file slug, and URL. See it in your command line by logging it:

<!-- console.log the page data -->
 page | log 

and the output

{
  date: 2020-05-13T19:31:02.218Z,
  inputPath: './src/index.html',
  fileSlug: '',
  filePathStem: '/index',
  url: '/',
  outputPath: '_site/index.html'
}

Contents with wrapper. Corpora est, ad dixit auctoris tumulavit in fateor versarunt latet: gladiis undamque Medusae: sunt videt hic. Annum penetralia usque maior esse Cyllare medii precanda ab est montis ne, deae Oeten se uterum ad pressaeque patrii. Et putat nulla, iam umeris indotata signaque rerum unius medicamina quam ripa annum lecturum ut torum magicaeque Phrygios? Victus arma, malo curas temptabimus illi oborto undis pharetra! Caelo risi cecidere quo ferrum: solis tacitus patrii, in lato.

Accessibility check

Section titled Accessibility check

Accessibility check

Section titled Accessibility check

Anchor Wrapper (Accessiblity Check). Smol Article heading anchors. Contents with wrapper. Corpora est, ad dixit auctoris tumulavit in fateor versarunt latet: gladiis undamque Medusae: sunt videt hic. Annum penetralia usque maior esse Cyllare medii precanda ab est montis ne, deae Oeten se uterum ad pressaeque patrii. Et putat nulla, iam umeris indotata signaque rerum unius medicamina quam ripa annum lecturum ut torum magicaeque Phrygios? Victus arma, malo curas temptabimus illi oborto undis pharetra! Caelo risi cecidere quo ferrum: solis tacitus patrii, in lato.

Article Anchors

Section titled Article Anchors

Article heading anchors. Contents with wrapper. Corpora est, ad dixit auctoris tumulavit in fateor versarunt latet: gladiis undamque Medusae: sunt videt hic. Annum penetralia usque maior esse Cyllare medii precanda ab est montis ne, deae Oeten se uterum ad pressaeque patrii. Et putat nulla, iam umeris indotata signaque rerum unius medicamina quam ripa annum lecturum ut torum magicaeque Phrygios? Victus arma, malo curas temptabimus illi oborto undis pharetra! Caelo risi cecidere quo ferrum: solis tacitus patrii, in lato.

Smol article anchors

Section titled Smol Article Anchors

Smol Article heading anchors. Contents with wrapper. Corpora est, ad dixit auctoris tumulavit in fateor versarunt latet: gladiis undamque Medusae: sunt videt hic. Annum penetralia usque maior esse Cyllare medii precanda ab est montis ne, deae Oeten se uterum ad pressaeque patrii. Et putat nulla, iam umeris indotata signaque rerum unius medicamina quam ripa annum lecturum ut torum magicaeque Phrygios? Victus arma, malo curas temptabimus illi oborto undis pharetra! Caelo risi cecidere quo ferrum: solis tacitus patrii, in lato.

Enable anchor links on content headings

Markdown-it Table of contents

Content - options in order

Contents with wrapper num

Section titled Contents

Contents with wrapper num Section titled Contents

Contents with wrapper. Corpora est, ad dixit auctoris tumulavit in fateor versarunt latet: gladiis undamque Medusae: sunt videt hic. Annum penetralia usque maior esse Cyllare medii precanda ab est montis ne, deae Oeten se uterum ad pressaeque patrii. Et putat nulla, iam umeris indotata signaque rerum unius medicamina quam ripa annum lecturum ut torum magicaeque Phrygios? Victus arma, malo curas temptabimus illi oborto undis pharetra! Caelo risi cecidere quo ferrum: solis tacitus patrii, in lato.

Contents with wrapper shortcode

Link to section titled Contents with wrapper shortcode

Contents with wrapper (shortcode). Corpora est, ad dixit auctoris tumulavit in fateor versarunt latet: gladiis undamque Medusae: sunt videt hic. Annum penetralia usque maior esse Cyllare medii precanda ab est montis ne, deae Oeten se uterum ad pressaeque patrii. Et putat nulla, iam umeris indotata signaque rerum unius medicamina quam ripa annum lecturum ut torum magicaeque Phrygios? Victus arma, malo curas temptabimus illi oborto undis pharetra! Caelo risi cecidere quo ferrum: solis tacitus patrii, in lato.

Alternitive. H2 is a link, and icon added with ::before

h2-link icon:before. Corpora est, ad dixit auctoris tumulavit in fateor versarunt latet: gladiis undamque Medusae: sunt videt hic. Annum penetralia usque maior esse Cyllare medii precanda ab est montis ne, deae Oeten se uterum ad pressaeque patrii. Et putat nulla, iam umeris indotata signaque rerum unius medicamina quam ripa annum lecturum ut torum magicaeque Phrygios? Victus arma, malo curas temptabimus illi oborto undis pharetra! Caelo risi cecidere quo ferrum: solis tacitus patrii, in lato.

h2-link icon:before (md). Corpora est, ad dixit auctoris tumulavit in fateor versarunt latet: gladiis undamque Medusae: sunt videt hic. Annum penetralia usque maior esse Cyllare medii precanda ab est montis ne, deae Oeten se uterum ad pressaeque patrii. Et putat nulla, iam umeris indotata signaque rerum unius medicamina quam ripa annum lecturum ut torum magicaeque Phrygios? Victus arma, malo curas temptabimus illi oborto undis pharetra! Caelo risi cecidere quo ferrum: solis tacitus patrii, in lato.

Alternitive H2's with a links inside. Icon aria-hidden

anchor icon aria hidden

anchor icon aria hidden

anchor icon aria hidden 🔗

anchor icon aria hidden

This is anchor icon aria.

Each Heading-anchor should be coded like this:

Option 1 - with wrapper:

The following short code - % hAnchor "h2 Title Here" % placed inside {}. In the future
I want to make shortcodes for all h tags - h2, h3, h4. They can be called h2Anchor, h3Anchor,
and so on.

The following short code (This option may be the best):
 hAnchor "Contents with wrapper shortcode"

will produce:
<div class="heading-anchor-wrapper" style="display: flex;align-items:center;">
    <h2 id="contents-with-wrapper-shortcode">Contents with wrapper shortcode</h2>
    <a class="anchor-link" href="#contents-with-wrapper-shortcode" style="margin: 1.5em 0 0 1em;padding: .5em">
        <span class="anchor-icon" aria-hidden="true">🔗</span>
        <span class="sr-only">Link to section titled Contents with wrapper (shortcode)</span>
    </a>
</div>



Other plain html options:
<div class="heading-wrapper" style="display: flex;align-items:center;">
    <h2 id="contents">Contents (with link)</h2>
        <a class="anchor-link" href="#contents" style="margin: 1.5em 0 0 1em;padding: .5em">
            <span class="anchor-icon" aria-hidden="true">
                <svg height="16" version="1.1" viewBox="0 0 16 16" width="16" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z" fill="currentcolor"></path></svg>
            </span>
            <span class="sr-only">Section titled Contents</span>
        </a>
</div>

<div class="heading-wrapper" style="display: flex;align-items:center;">
    <h2 id="contents">Contents (with link)</h2>
        <a class="anchor-link" href="#contents" style="margin: 1.5em 0 0 1em;padding: .5em">
            <span class="anchor-icon" aria-hidden="true">&#128279;</span>
            <span class="sr-only">Section titled Contents</span>
        </a>
</div>

Option 2 - without wrapper:

<h2 id="contents">Contents (with link)</h2>
<a class="anchor-link" href="#contents" style="margin: 1.5em 0 0 1em;padding: .5em">
    <span class="anchor-icon" aria-hidden="true">
        <svg height="16" version="1.1" viewBox="0 0 16 16" width="16" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z" fill="currentcolor"></path></svg>
    </span>
    <span class="sr-only">Section titled Contents</span>
</a>

<h2 id="contents">Contents (with link)</h2>
<a class="anchor-link" href="#contents" style="margin: 1.5em 0 0 1em;padding: .5em">
    <span class="anchor-icon" aria-hidden="true">&#128279;</span>
    <span class="sr-only">Section titled Contents</span>
</a>

Option 3 - inside of h2:

<h2 id="attributes" class="anchor">
    <a href="#attributes" title="Permalink to Attributes">Attributes (html)</a>
</h2>

Optinon 4 - option 3 above in MD:

## [anchor heading (md)](#anchor) { #anchor .anchor }

Optinon 5 - option 4 with anchor icon aria-hidden:

## [anchor icon aria hidden](#anchor-icon) **&#128279;**{ aria-hidden="true" } { #anchor .anchor-icon-aria }

## [anchor icon aria hidden](#anchor-icon) **&#128279;**{ aria-hidden="true" } 
{ #anchor .anchor-icon-aria }

This gives:
<h2 id="anchor" class="anchor-icon-aria">
    <a href="#anchor-icon">anchor icon aria hidden</a> 
    <strong aria-hidden="true">🔗</strong>
</h2>

And ebbedding the aria-hidden=true icon inside the a-link:
## [anchor icon aria hidden **&#128279;**{ aria-hidden="true" }](#anchor-icon) { #anchor .anchor-icon-aria }

gives:
<h2>
    <a href="#anchor-icon">
        anchor icon aria hidden 
        <strong aria-hidden="true">🔗</strong>
    </a>
</h2>

Optinon 6 - icon inside a:link form https://www.accessibility-developer-guide.com/:

<div class="anchor-surround">
    <h3 id="play-with-them" class="js-anchor anchor-element" data-has-module="true">Play with them!</h3>
    <a class="anchor-link" href="#play-with-them">
        <span aria-hidden="true">#</span>
        <span class="visuallyhidden">Link to heading "Play with them!"</span>
    </a>
</div>

Contents (with link)

To implement accessible headings with anchors for each post in Markdownit-attr, make Custom rendering.

second 🔗{}

second

Next h2

Section titled Contents

Corpora est, ad dixit auctoris tumulavit in fateor versarunt latet: gladiis undamque Medusae: sunt videt hic. Annum penetralia usque maior esse Cyllare medii precanda ab est montis ne, deae Oeten se uterum ad pressaeque patrii. Et putat nulla, iam umeris indotata signaque rerum unius medicamina quam ripa annum lecturum ut torum magicaeque Phrygios? Victus arma, malo curas temptabimus illi oborto undis pharetra! Caelo risi cecidere quo ferrum: solis tacitus patrii, in lato.

Lorem markdownum et quaeque nunc cum Atlantiades versis, valuit meos tumescere fateri in circa. Ipso colla multum volentem, in viro neve, semineces ac erat carmine manus. Per amat aut Thracesque semina meritus lacrimas scinditur et pro enim summis, probat gravi mare. Cuspide sustulit, secutis alte, muta tibi me o torum. Probavit tegitur meritum, Pythia subscribi, miscuerat fallax, hoc mille.

Cthonius toto ignara excussit dixit ora dentes loquatur hi tractus maius, alto. Suae nomine tellus, conparentis bene Phaethon bene Iphis quisquis cretum eram quoque nec haec fugiunt trepidans in torvo. Columbae extrema occupat huic, precari enim rupem equos his fama. Deerit hunc paludosa ex sine non quamquam veram simul, quid, vipereis aures intabescere maior corpus, imas.

Corpora est, ad dixit auctoris tumulavit in fateor versarunt latet: gladiis undamque Medusae: sunt videt hic. Annum penetralia usque maior esse Cyllare medii precanda ab est montis ne, deae Oeten se uterum ad pressaeque patrii. Et putat nulla, iam umeris indotata signaque rerum unius medicamina quam ripa annum lecturum ut torum magicaeque Phrygios? Victus arma, malo curas temptabimus illi oborto undis pharetra! Caelo risi cecidere quo ferrum: solis tacitus patrii, in lato.

Next h2

Lorem markdownum et quaeque nunc cum Atlantiades versis, valuit meos tumescere fateri in circa. Ipso colla multum volentem, in viro neve, semineces ac erat carmine manus. Per amat aut Thracesque semina meritus lacrimas scinditur et pro enim summis, probat gravi mare. Cuspide sustulit, secutis alte, muta tibi me o torum. Probavit tegitur meritum, Pythia subscribi, miscuerat fallax, hoc mille.

Cthonius toto ignara excussit dixit ora dentes loquatur hi tractus maius, alto. Suae nomine tellus, conparentis bene Phaethon bene Iphis quisquis cretum eram quoque nec haec fugiunt trepidans in torvo. Columbae extrema occupat huic, precari enim rupem equos his fama. Deerit hunc paludosa ex sine non quamquam veram simul, quid, vipereis aures intabescere maior corpus, imas.

Quae sedes percussit

Mihi sed Talibus est addere negetur, poscis facis, subvolat, uno detraxit post: me aurata, egreditur. Se moenia quosque commune: ait sive. Sit non per voce vinctus, ut frondes hanc avido si naturae saucius.

Sequenti albet; iram nisi ima montis sanguine parmam quinquennem. Illo haut, deus est percurrere gaudia meruisse pia simul; ire. Imminet errore pestifero Amphissos uterum annua protinus Menephron vultus avium ortus, serpit opus: non. Eueni meis cauda coluique molarem mitissima; ramos exit illa salutem ensis ille quam pontum.

Ferre incipit Melanthus exiguo

Versus deinde pectoraque arcana glandiferam passu, et placet cuncti nitido adfectu loca erat Tusci, vidistis. Cum oculis carinas simul fatum quaterque anxia paverunt tegat, repulsam et invicti fundebat et pavit a seges per patris. Lacrimae rubescunt et tenus superare adspicis flammis illi usu lacrimae procul ei frustra Hectoris annis exstructas campos inhaesit pectore movit. Ipse nuper densis aevo anguem, vides apta aquis, creditur. Es tulit culpa, cruore arma ore premunt apte, sua!

Alto operum concolor Daedalus. Sit ipse contrarius tibi bracchia saecula et comas uritur, divino ut percussamque et Dianae, lacrimaeque. Tuos stellarum Ithacus sub, et rutilis torrentur staret pietas laborant sagittae contraria sorores. Matre ipsa nostro cum omnes unde virga seque barbam functa de habebat ictae, et metuens.

Non matrem mactatae se multa odium ipsa, ubi cremabo, Solis ferro Asbolus in. Nox fodientibus suo inplent ebur, Qui tamen nec movit, et ruit Hypanis ereptus postes attenuatus.

Quae sedes percussit

Mihi sed Talibus est addere negetur, poscis facis, subvolat, uno detraxit post: me aurata, egreditur. Se moenia quosque commune: ait sive. Sit non per voce vinctus, ut frondes hanc avido si naturae saucius.

Sequenti albet; iram nisi ima montis sanguine parmam quinquennem. Illo haut, deus est percurrere gaudia meruisse pia simul; ire. Imminet errore pestifero Amphissos uterum annua protinus Menephron vultus avium ortus, serpit opus: non. Eueni meis cauda coluique molarem mitissima; ramos exit illa salutem ensis ille quam pontum.