the problem

you want to have a very large document, but avoid header names collision
painfully, github's markdown/rst/asciidoc do not allow to give a header a custom anchor id/link
so, if you have

## some header

or

== some header

or

***
some header

you are stuck with github.com/link-to-doc#some-header
you cannot use raw <h2 id="different-anchor">some-header</h2> either, it still gets replaced with #some-header

the hash approach/solution

## First heading <sup><sup><sub>2020-09-05 <a name="235ffda" href="#235ffda">235ffda</a></sub></sup></sup>

renders as

First heading ^{^{_{2020-09-05 235ffda}}}

use headers freely, but append to each

 <sup><sup><sub>2020-09-05 <a name="235ffda" href="#235ffda">235ffda</a></sub></sup></sup>

where a random hash gives any header uniqueness
yes, it is a little taxing code-wise, but:
- you get standard readable links to your header still, but with hash appended
- if you rename the header and link breaks, user can use hash from old link to find the same header, but with new title
- because hash of every header in the documnet never-ever changes, HOORAY!
- or: hash itself is a link(anchor) and user can copy that link, which will never break
at the cost of having a small superscript over every header, you get header-name-freedom and unique persistent links
best of both worlds - auto generated header link and unique persisten hash for every single header

test

My Header Name

First heading ^{^{_{2020-09-05 4dsdwd1c}}}

some blue text.
a
b

First heading ^{^{_{2020-09-05 53cf31}}}

some blue text.
a
b

First heading ^{^{_{2020-09-05 4dsdwd1c}}}

some blue text.
a
b

First heading ^{^{_{2020-09-05 7vwergv}}}

some blue text.
a
b

First heading ^link

First heading ^_3y2ud

First heading ^{^35tuh}

First heading ^{_{^_32jfd}}

First heading ^{^_8743hf}

First heading ^{_^67123d}

First heading ^783fh

Second heading

# Second heading

heading

First heading #

Second heading

Install-qwe

wer
rtgrq

Install-qwe

Install

blah blah

sadidul012 / lab.gtihub-markdown-big-doc-header-name-uniqueness-dilemma-2020-09-05 Goto Github PK

lab.gtihub-markdown-big-doc-header-name-uniqueness-dilemma-2020-09-05's Introduction

the problem

the hash approach/solution

First heading 2020-09-05 235ffda

test

My Header Name

First heading 2020-09-05 4dsdwd1c

First heading 2020-09-05 53cf31

First heading 2020-09-05 4dsdwd1c

First heading 2020-09-05 7vwergv

First heading link

First heading 3y2ud

First heading 35tuh

First heading 32jfd

First heading 8743hf

First heading 67123d

First heading 783fh

Second heading

heading

First heading #

Second heading

Install-qwe

Install-qwe

Install-qwe

Install-qwe

Install

Heading123

Heading

Heading

lab.gtihub-markdown-big-doc-header-name-uniqueness-dilemma-2020-09-05's People

Watchers

Recommend Projects

Recommend Topics

Recommend Org

First heading ^{^{_{2020-09-05 235ffda}}}

First heading ^{^{_{2020-09-05 4dsdwd1c}}}

First heading ^{^{_{2020-09-05 53cf31}}}

First heading ^{^{_{2020-09-05 4dsdwd1c}}}

First heading ^{^{_{2020-09-05 7vwergv}}}

First heading ^link

First heading ^_3y2ud

First heading ^{^35tuh}

First heading ^{_{^_32jfd}}

First heading ^{^_8743hf}

First heading ^{_^67123d}

First heading ^783fh