FLUID-6206: Infusion docs header links do not work when viewed in GitHub...

Description

In working to migrate from "marked" to "markdown-it", I found a problem with our current links, at least on the Model Transformation API page. The handling of dots in grade names is not consistent with what GitHub does.

For example, the initial link in the "List of available transformations" points to:

https://docs.fluidproject.org/infusion/development/ModelTransformationAPI.html#output-a-value-given-as-input-fluid-transforms-value-and-fluid-transforms-identity-

The generated placeholder anchor matches:

<a class="infusion-docs-anchor" aria-hidden="true" href="#output-a-value-given-as-input-fluid-transforms-value-and-fluid-transforms-identity-">...</a>

However, looking at the same page in our GitHub repo, the generated link is:

<a href="#output-a-value-given-as-input-fluidtransformsvalue-and-fluidtransformsidentity" aria-hidden="true" class="anchor" id="user-content-output-a-value-given-as-input-fluidtransformsvalue-and-fluidtransformsidentity">...</a>

So, GitHub treats the dots as something to be stripped rather than as something to be replaced with a dash. The new plugin I'm proposing using instead of docpad-marked-plugin has a plugin that generates exactly the same placeholders as GitHub, I'm proposing updating the existing links so that they work with both the new plugin and from within GitHub.

Comments

• Tony Atkins [RtF] commented 2017-10-10T04:19:18.209-0400

  The fixes for the vast majority of the header links is included in this pull:

  https://github.com/fluid-project/infusion-docs/pull/129

• Tony Atkins [RtF] commented 2018-05-24T03:56:11.773-0400

  The linked pull (now merged) added link checking, including header links, and all links were verified working.