Uploaded image for project: 'Fluid Infusion'
  1. Fluid Infusion
  2. FLUID-6207

A single header id in the docs does not match what GitHub generates...

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Open
    • Priority: Minor
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: Tech. Documentation
    • Labels:
      None

      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.

        Attachments

          Activity

            People

            Assignee:
            Unassigned Unassigned
            Reporter:
            the-t-in-rtf Tony Atkins
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Dates

              Created:
              Updated: