SensorsIot / IOTstack

Docker stack for getting started on IOT on the Raspberry PI
GNU General Public License v3.0
1.44k stars 307 forks source link

Markdown anchor refactoring suggestion #558

Closed ukkopahis closed 2 years ago

ukkopahis commented 2 years ago

Currently custom anchors on are authored as inline-html:

## <a name="quickStart"></a>Quick Start

This doesn't change the autogenerated Permanent link. So in essence there are two anchors for the same thing: image

Using the attribute list extension, id attributes can be added/changed by writing:

## Quick Start { #quickStart }

Resulting in: image

Cleaner markdown and cleaner html: win-win!

Comments about me doing a PR of bulk-refactoring this (using sed)?

@Paraphraser hopefully such a refactoring won't bork your markdown editor? If it does, can you also test if adding the optional colon would work better, i.e.

## Quick Start {: #quickStart }