search

cabforum / build-guidelines-action

Action to build Pandoc-flavored Guidelines into their final form
0 stars 3 forks source link

Change headings to GitHub style headings #5

Closed sleevi closed 3 years ago

sleevi commented 3 years ago

Pandoc's default style for headings, as documented at https://pandoc.org/MANUAL.html#headings-and-sections , is to remove leading numbers from headings. This strips out leading section identifiers (e.g. #foo instead of #1-foo). Pandoc does this to be compatible with HTML 4.

This changes the Markdown reader to use the GitHub style of creating section headers, which covers spaces to dashes, lowercases everything, and removes punctuation other than - and _. Importantly, this preserves numbers: "11.1.1 Foo" becomes "#11111-foo" instead of just "#foo".

This makes it much easier to understand why a link was bad, and so the Link checking filter is also updated to dump all the valid identifiers whenever there is a broken link, which hopefully makes it easier to correct the link in the event of a typo.

sleevi commented 3 years ago

@aarongable Based on your feedback on https://github.com/cabforum/servercert/pull/235 , this changes the link style. I quite like it over what it was, and hopefully this makes it even easier to spotcheck links.