Uploaded image for project: 'Jenkins Website'
  1. Jenkins Website
  2. WEBSITE-651

Honor anchors inside GitHub README when rendering on plugins.jenkins.io

    Details

    • Type: Improvement
    • Status: To Do (View Workflow)
    • Priority: Minor
    • Resolution: Unresolved
    • Component/s: plugin-site
    • Labels:
      None
    • Similar Issues:

      Description

      Documentation for certain plugins (git plugin, configuration as code plugin, etc.) can be quite lengthy. Navigation can be assisted by a table of contents at the top of the documentation page. That navigation can be implemented with the GitHub markdown convention which creates anchor names based on the heading text.

      For example, the git plugin extensions section is linked from the contents section and works in the README on GitHub. The same links do not work on the plugins.jenkins.io site.

        Attachments

          Activity

          There are no comments yet on this issue.

            People

            • Assignee:
              Unassigned
              Reporter:
              markewaite Mark Waite
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated: