Metadata
- Source
- FLUID-6207
- Type
- Bug
- Priority
- Minor
- Status
- Closed
- Resolution
- Migrated
- Assignee
- N/A
- Reporter
- Tony Atkins [RtF]
- Created
2017-10-04T08:40:37.153-0400 - Updated
2022-03-14T13:39:55.508-0400 - Versions
- N/A
- Fixed Versions
- N/A
- Component
-
- Tech. Documentation
Description
We currently have over a hundred links in the documentation where the heading IDs do not match between GitHub and docpad. This means that the links are clickable on our site, but not when viewing the raw markdown on GitHub.
Assuming the pull associated with FLUID-6205 is merged, nearly all of these will be addressed. The one holdout is the heading for fluid.log in CoreAPI.html.
The text of the heading is:
fluid.log([logLevel, arg1, ... argn])
GitHub generates the header ID as "fluidlogloglevel-arg1--argn".
The new combination of markdown-it and markdownit-anchor generates the ID as "fluidlogloglevel-arg1-argn" (note the single dash between "arg1" and "argn").
Our current combination use of docpad-plugin-marked generates the ID as "fluid-log-loglevel-arg1-argn-", so the brokenness of the link on GitHub is not new behaviour, even if the details are a little different.
I am filing this ticket in case the problem occurs more often, in which case I would suggest preparing a ticket and/or pull against markdownit-anchor.
Comments
-
Justin Obara commented
2022-03-14T13:39:55.484-0400 Migrated to Infusion-Docs Issue #225