remarkjs / remark-github

remark plugin to link references to commits, issues, pull-requests, and users, like on GitHub

Home Page:https://remark.js.org

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Add option to use disable @mentions linking

felixfbecker opened this issue · comments

Initial checklist

Problem

In our content, people often use @mentions to mean Slack handles, not GitHub handles. Since the GitHub usernames are not verified by this plugin, it would result in a lot of false or invalid links. I would really like to use the plugin for the other functionality though.

Solution

Would love an option to disable @mention highlighting.

Alternatives

None that I can think of.

commented

What is the reason you’re using this plugin?

All functionality except the @mentions: Linking/shortening repo links, PR links, issue links, commit links, ...

commented

Hmm, yeah, I think I’d be open to this. Care to work on a PR?

Yep, can look into this (maybe next week).

Would also be nice to have an option to still allow team handles like @sourcegraph/my-team, as those aren't ambiguous with Slack handles.

Hi! This was marked as ready to be worked on! Note that while this is ready to be worked on, nothing is said about priority: it may take a while for this to be solved.

Is this something you can and want to work on?

Team: please use the area/* (to describe the scope of the change), platform/* (if this is related to a specific one), and semver/* and type/* labels to annotate this. If this is first-timers friendly, add good first issue and if this could use help, add help wanted.

Oh, you beat me to it. Thank you so much, works great! ❤️