@mentions do not render in README.md

[codeaholics]

@mentions (https://help.github.com/articles/github-flavored-markdown#name-and-team-mentions-autocomplete) do not render in README.md

[gjtorikian]

And they probably never will.

@mentions are intended to bring attention to someone to a piece of code or an issue. They're not just hot-links out to a username.

[Haroenv]

To me another use would be easily writing out who helped in the writing of a certain piece of code, something which is done in README's too.

[ChappIO]

Hm would like to see this feature. When writing documentation and talking about decisions made it would be really convenient if the links would be parsed automatically.

[idibidiart]

A huge oversight IMO... it shouldn't take much to support. Why was it excluded from markdown?

[Xaekai]

I ran into this issue just now. Thanks for making me wonder why the hell the Special Thanks section of my README.md wasn't working. I imagined it would be a common use case. Omitting it is an objectively controversial decision.

Also, whatever you're doing to make it not render mentions is destroying line breaks. One line rendered. Is actually three lines

[dimitarg]

Does it make sense to render mentions in CREDITS.md? That's what brought me here. Should I file another issue?

[dimitarg]

1075 opened

[hansfpc]

You can 'hack' it creating a Link with the label "@theuseryouwant" that redirects to the user profile, lol

[rosy1280]

it would be useful to be able to mention someone in markdown, say on the wiki, if you're using the check box list, because then you assign specific people to the checkbox i.e.

• [ ] @rosy1280 do something here

[AuthorOfTheSurf]

You can also use @hansfpc 's solution to do the same with linking to teams:

Replace the org name, as well as "team-name" in both spots:

[@VideoAmp/team-name]( https://github.com/orgs/VideoAmp/teams/team-name/members )

This solved my case because we just needed a way to dynamically link because team members can change. This linking not being automatic is OK, and may even be better because it would allow the same markdown linking to work if viewed outside of Github.

[moshfeu]

You can also use @hansfpc 's solution to do the same with linking to teams:

Replace the org name, as well as "team-name" in both spots:

[@VideoAmp/team-name]( https://github.com/orgs/VideoAmp/teams/team-name/members )`

This solved my case because we just needed a way to dynamically link because team members can change. This linking not being automatic is OK, and may even be better because it would allow the same markdown linking to work if viewed outside of Github.

The only thing is that it missing the popover :(

[edsonayllon]

Is this not going to be included? Would be great to provide credit in README or other markdown files.

[jasomdotnet]

7 y.o. issue :D

[ParisNeo]

I ended up using simple classical markdown linking to the contributer's name: [contributers's name](https://github.com/contributer's name)

It's a little longer but there is a short way using macros and text preprocessor.

If you use pp then you can create a simple macro to do this automatically for you. You preprocess your md file then voila!!

The idea is that you create unprocessed_README.md that declares and uses this macro. Then you call pp to generate your final README.md

I created this simple code to add to your unprocessedREADME.md !define(cite)(!1: )

This creates a new macro called cite that you call like this !cite(contributer's name) whenever you want to cite a contributer.

Then you convert the file like this

pp unprocessed_README.md > README.md

To hide this unprocessed_README.md file, i put it in a misc folder. The command becomes :

pp misc/unprocessed_README.md > README.md

It is still 8 characters longer than what you asked 7 years ago, but unless github adds explicit support to this or maybe pp could add a @ internal macro, or you create your own text preprocessor that looks for words starting with @ and replace them with the code above, I don't see haw simpler can we do this.

For the record, I did use cite_ so that if your md file containes the word cite, it doesn't get converted. you can use just c or ci or whatever you want to reduce the number of characters you use.

I tried this in my QPanda3D project. The README.md you see is the final output. To see the original code, look at misc/unprocessed_README.md.

I hope this helps.

[pavanvamsi3]

Why can't we simply use href? pavanvamsi3

[moshfeu]

Why can't we simply use href? pavanvamsi3

https://github.com/github/markup/issues/209#issuecomment-477658903

[MadaraUchiha]

In case you are interested, I wrote a simple userscript which linkifies @mentions in markdown files including the popover.

https://gist.github.com/MadaraUchiha/a486bd8f93b0fc6df1bc97d9b8fca045 -- To install with userscript extensions, just click on the "Raw" button on that gist.

[simonwuelker]

How is this not a feature. Like actually, linking to profiles from a README (with a popover) would be amazing

[ndrewtl]

Once again petitioning @github to reconsider-- having @mentions in README would be an extremely helpful feature

[warstrolo]

Indeed this would be usefull !

[kangalio]

@mentions are intended to bring attention to someone to a piece of code or an issue. They're not just hot-links out to a username.

I can see the philosophical reasoning but let's stay pragmatic

Advantages:

• mentioning users in a README allows readers to immediately view the user, via click or hover over, which is very convenient
• as consequence, user mentions will be used more often, making users more interconnected

Disadvantages:

• @username mentions cannot be clicked outside GitHub ([@username](https://github.com/username can)

[warstrolo]

Well then when we put a link like you said, it should pop the user / organisation GitHub profile, like with the actual mention.

[cosmiccoincidence]

It's 2023 and I would also like this feature.

[xmaxrayx]

can you guys bring this future?

[htransteven]

+1

[shrey150]

+1 would be super useful

[reisir]

Give GitHub users a unique ID (already exists in the backend I quarantee it)

Make @ mentions used in the markdown editors across github generate a link to that users profile. Like so: [GitHub user](github.com/user/25346879)

Render these links as mentions on GitHub: @reisir

And as they are normal markdown links they also work outside of GitHub: GitHub user

The unique ids solve people changing their usernames. GitHub can get the current username for rendering the mention.

[boshmaf]

+1

[phoriah]

+1 Bump

[davidpagnon]

It's been over 10 years but I'm still interested 😆

[lovely-necromancer]

+1

[LifeDreamer24]

+1

[mnmami]

And +1 from 2024. This lowers the chances GH to be used for project documentation. Not wise move.

[sapondanaisriwan]

+1

[Carnix]

+1 Every time I do this on any project I'm working on (seems like every single one, tbh), I'm reminded of how dumb it is that it doesn't work and a Google search lands me here. Most of my work in on my company's GHE servers, so even if GH adds it here, it will probably be years before it ends up benefiting me, but still - would be nice to have this.

[alessandrobelli]

+1

[nickfollett]

+1, there should be support for contextually rendering user links in markdown of committed files vs. markdown in uncommitted comments, issues, etc.