Skip to content

Support auto-linking #... issue references to pantsbuild/pants #203

Open
@huonw

Description

@huonw

In pantsbuild/pants#20492 (comment), we noticed that it's convenient to write #... issue references in docs, and some places (particularly GitHub renderers) will auto-link them.

If we could do the same in our published website that might be nice, e.g. replace matches of /#([0-9]{3,})/ with [#\1](https://github.com/pantsbuild/pants/issues/\1) (or some equivalent). Notes:

  • Preferably we'd do this in a Markdown aware-way, only in body text, and not within code blocks, existing links etc.
  • The {3,} is to require at least #123, to reduce spurious references like a reference to a list item ("#1 is a good option").

From a quick skim of the docusaurus docs and plugins, there doesn't appear to be existing support for this, but I might've missed it.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions