-
Notifications
You must be signed in to change notification settings - Fork 3.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
@mentions do not render in README.md #209
Comments
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. |
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. |
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. |
A huge oversight IMO... it shouldn't take much to support. Why was it excluded from markdown? |
I ran into this issue just now. Thanks for making me wonder why the hell the Also, whatever you're doing to make it not render mentions is destroying line breaks. |
All frames regarding emotes are done. Updated readme yet again due to github/markup#209
Does it make sense to render mentions in CREDITS.md? That's what brought me here. |
#1075 opened |
Unfortunately for us, GitHub explicitly rejected mentions in READMEs, github/markup#209, so here's a solution.
Unfortunately for us, GitHub explicitly rejected mentions in READMEs, github/markup#209, so here's a solution.
Unfortunately for us, GitHub explicitly rejected mentions in READMEs, github/markup#209, so here's a solution. per #4
github/markup#209 strikes again!
You can 'hack' it creating a Link with the label "@theuseryouwant" that redirects to the user profile, lol |
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.
|
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:
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. |
As per github/markup#209, @mentions don't work on readme files. Therefore, added markdown links to each contributor's GitHub profile
The only thing is that it missing the popover :( |
Is this not going to be included? Would be great to provide credit in README or other markdown files. |
7 y.o. issue :D |
I ended up using simple classical markdown linking to the 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 unprocessed_README.md 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. 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. 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. |
Why can't we simply use href? pavanvamsi3 |
How is this not a feature. Like actually, linking to profiles from a README (with a popover) would be amazing |
Mentions don't work on GitHub according to github/markup#209 (comment)
@mentions [don't work in markdown files](github/markup#209)
As currently GitHub doesn't add links automatically: github/markup#209 Also replace fredbrancz handle to brancz, as fredbrancz is his twitter handle, which is also linked in his GitHub profile
Once again petitioning @github to reconsider-- having @mentions in README would be an extremely helpful feature |
As currently GitHub doesn't add links automatically: github/markup#209 Also replace fredbrancz handle to brancz, as fredbrancz is his twitter handle, which is also linked in his GitHub profile
* Link GitHub handles to GitHub profiles As currently GitHub doesn't add links automatically: github/markup#209 Also replace fredbrancz handle to brancz, as fredbrancz is his twitter handle, which is also linked in his GitHub profile * Remove typo Text added twice * How to add yourself to @monitoring-team * Additional instructions for requesting access to team-monitoring * Update how to join aos-devel aos-devel was recently moved to google groups https://source.redhat.com/groups/public/openshift_tam_sync_up/blog/jun_13_2022_call_agena * add missing quote
Indeed this would be usefull ! |
I can see the philosophical reasoning but let's stay pragmatic Advantages:
Disadvantages:
|
It's 2023 and I would also like this feature. |
can you guys bring this future? |
+1 |
+1 would be super useful |
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: 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. |
+1 |
+1 Bump |
It's been over 10 years but I'm still interested 😆 |
+1 |
+1 |
And +1 from 2024. This lowers the chances GH to be used for project documentation. Not wise move. |
+1 |
+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. |
+1 |
@mentions (https://help.github.com/articles/github-flavored-markdown#name-and-team-mentions-autocomplete) do not render in README.md
The text was updated successfully, but these errors were encountered: