Feature proposal: profile readmes #5734

@fangmarks commented on GitHub (Nov 7, 2020):

This'd be a really neat feature!

I currently link my main Account on my own Instance, but it would be neat if I could write a profile readme to basically list all my works, since they're not in one place and not every account on my instance is mine.

i.e. I could do something like this:


- [Account Name](LINK)
  - [Project](LINK)
  - [Project](LINK)

- [Account Name](LINK)
  - [Project](LINK)
  - [Project](LINK)
  - [Project](LINK)
  - [Project](LINK)

This would make it, for me personally, easier to even put my personal Gitea on a Résumé/CV and then make it easy for potential employers to look through my works

@fangmarks commented on GitHub (Nov 7, 2020): This'd be a really neat feature! I currently link my main Account on my own Instance, but it would be neat if I could write a profile readme to basically list all my works, since they're not in one place and not every account on my instance is mine. i.e. I could do something like this: ```md - [Account Name](LINK) - [Project](LINK) - [Project](LINK) - [Account Name](LINK) - [Project](LINK) - [Project](LINK) - [Project](LINK) - [Project](LINK) ``` This would make it, for me personally, easier to even put my personal Gitea on a Résumé/CV and then make it easy for potential employers to look through my works

GiteaMirror commented

@jolheiser commented on GitHub (Jun 18, 2021):

What are thoughts on this simply being a field in profile settings?

Does it need to be in a magical repo with the same name as your username? (It does on GH, but in terms of Gitea)

I suppose being in a repo allows users to hook it into CI, but a repo with a single README always struck me as hacky.

@jolheiser commented on GitHub (Jun 18, 2021): What are thoughts on this simply being a field in profile settings? Does it _need_ to be in a magical repo with the same name as your username? (It does on GH, but in terms of Gitea) I suppose being in a repo allows users to hook it into CI, but a repo with a single README always struck me as hacky.

GiteaMirror commented

@ptman commented on GitHub (Jun 21, 2021):

Repo is much nicer, with history etc. Only put stuff in the DB when it needs to be queried.

@ptman commented on GitHub (Jun 21, 2021): Repo is much nicer, with history etc. Only put stuff in the DB when it needs to be queried.

GiteaMirror commented

@fangmarks commented on GitHub (Jun 23, 2021):

i like how github did it tbh

@fangmarks commented on GitHub (Jun 23, 2021): i like how github did it tbh

GiteaMirror commented

@CodeDoctorDE commented on GitHub (Aug 22, 2021):

It would be cool if it will be a thing in 1.16.
If it will be possible, it makes sense to have this functionality on orgs too.

@CodeDoctorDE commented on GitHub (Aug 22, 2021): It would be cool if it will be a thing in 1.16. If it will be possible, it makes sense to have this functionality on orgs too.

GiteaMirror commented

@fangmarks commented on GitHub (Aug 22, 2021):

Having it on Orgs would be AMAZING, ngl.

A Description is neat but a profile readme, with the same support as all other markdown files, would be even better because we could go way more in depth when it comes to saying what an Org is about, if we choose to do that

@fangmarks commented on GitHub (Aug 22, 2021): Having it on Orgs would be AMAZING, ngl. A Description is neat but a profile readme, with the same support as all other markdown files, would be even better because we could go way more in depth when it comes to saying what an Org is about, if we choose to do that

GiteaMirror commented

@christaus commented on GitHub (Dec 5, 2021):

We are in 2021 and I strongly agree with this feature, I fond this webpage looking for a way to use a README.md as profile on gitea.
This is absolutly a great idea on github, that could be on gitea.
Thank you for the one who will change the world to me 👍🏻 .

@christaus commented on GitHub (Dec 5, 2021): We are in 2021 and I strongly agree with this feature, I fond this webpage looking for a way to **use a README.md as profile on gitea**. This is absolutly a **great idea on github**, that **could be on gitea**. Thank you for the one who will change the world to me 👍🏻 .

GiteaMirror commented

2025-11-02 06:34:22 -06:00

@lunny commented on GitHub (Dec 5, 2021):

Where should we store the README.md? how about in a git repository named <user_name>/-/profile, so that you can git clone it and push to server?

@lunny commented on GitHub (Dec 5, 2021): Where should we store the `README.md`? how about in a git repository named `<user_name>/-/profile`, so that you can git clone it and push to server?

GiteaMirror commented

@CodeDoctorDE commented on GitHub (Dec 5, 2021):

In github its github.com/Username/Username

@CodeDoctorDE commented on GitHub (Dec 5, 2021): In github its github.com/Username/Username

GiteaMirror commented

2025-11-02 06:34:22 -06:00

@lunny commented on GitHub (Dec 5, 2021):

github.com/Username/Usernam maybe conflicted with user's repository. i.e. gitea/gitea. Or /~<user_name>, I think it's compatible with something.

@lunny commented on GitHub (Dec 5, 2021): `github.com/Username/Usernam` maybe conflicted with user's repository. i.e. `gitea/gitea`. Or `/~<user_name>`, I think it's compatible with something.

GiteaMirror commented

2025-11-02 06:34:22 -06:00

@CodeDoctorDE commented on GitHub (Dec 5, 2021):

On orgs, github uses .github as repository name like https://github.com/LinwoodCloud/.github.
Maybe gitea.com/Username/.gitea repository?

@CodeDoctorDE commented on GitHub (Dec 5, 2021): On orgs, github uses `.github` as repository name like https://github.com/LinwoodCloud/.github. Maybe gitea.com/Username/.gitea repository?

GiteaMirror commented

@lunny commented on GitHub (Dec 5, 2021):

On orgs, github uses .github as repository name like https://github.com/LinwoodCloud/.github. Maybe gitea.com/Username/.gitea repository?

That sounds also OK.

@lunny commented on GitHub (Dec 5, 2021): > On orgs, github uses `.github` as repository name like https://github.com/LinwoodCloud/.github. Maybe gitea.com/Username/.gitea repository? That sounds also OK.

GiteaMirror commented

@christaus commented on GitHub (Dec 5, 2021):

Simply like that: https://github.com/cGIfl300 it is stored on https://github.com/cGIfl300/cGIfl300 indeed the repository using your own nickname is indicated as "special" and the README.md is show next to your profile. (you can see my profile, I do use it)

@christaus commented on GitHub (Dec 5, 2021): > ![screenshot](https://zupimages.net/up/21/48/2w6b.png) Simply like that: https://github.com/cGIfl300 it is stored on https://github.com/cGIfl300/cGIfl300 indeed the repository using your own nickname is indicated as "special" and the README.md is show next to your profile. (you can see my profile, I do use it)

GiteaMirror commented

@lunny commented on GitHub (Dec 6, 2021):

Or we can reuse repository_type, so it's a profile repository, other types are template and etc.

@lunny commented on GitHub (Dec 6, 2021): Or we can reuse `repository_type`, so it's a profile repository, other types are `template` and etc.

GiteaMirror commented

@dayswith commented on GitHub (Dec 28, 2021):

Don't forget to also implement this on organizations.

@dayswith commented on GitHub (Dec 28, 2021): Don't forget to also implement this on organizations.

GiteaMirror commented

@Akselmo commented on GitHub (Jan 13, 2022):

Really hope to see this, I think it makes exploring profiles more fun and especially now that federation is coming, it can help people find people easier.

@Akselmo commented on GitHub (Jan 13, 2022): Really hope to see this, I think it makes exploring profiles more fun and especially now that federation is coming, it can help people find people easier.

GiteaMirror commented

@MisileLab commented on GitHub (Apr 24, 2022):

This feature would be great!

@MisileLab commented on GitHub (Apr 24, 2022): This feature would be great!

GiteaMirror commented

@mind-overflow commented on GitHub (May 30, 2022):

hey! no update on this?

@mind-overflow commented on GitHub (May 30, 2022): hey! no update on this?

GiteaMirror commented

@hrueschwein commented on GitHub (Jun 23, 2022):

Also waiting for this :)

@hrueschwein commented on GitHub (Jun 23, 2022): Also waiting for this :)

GiteaMirror commented

@pratik9315 commented on GitHub (Jul 2, 2022):

Hey there! I saw this issue listed on bsource a year back. I would like to work on it if its still open :)

@pratik9315 commented on GitHub (Jul 2, 2022): Hey there! I saw this issue listed on bsource a year back. I would like to work on it if its still open :)

GiteaMirror commented

@justusbunsi commented on GitHub (Jul 2, 2022):

Hey there! I saw this issue listed on bsource a year back. I would like to work on it if its still open :)

@pratik2315 Contributions are always welcome. The issue is still open, there is no PR referenced, so... grab yourself a cup of tea and create some magic, I'd say. 😉

Feel free to join the Gitea Discord server in case you have questions. There is also a develop channel.

@justusbunsi commented on GitHub (Jul 2, 2022): > Hey there! I saw this issue listed on bsource a year back. I would like to work on it if its still open :) @pratik2315 Contributions are always welcome. The issue is still open, there is no PR referenced, so... grab yourself a cup of tea and create some magic, I'd say. 😉 Feel free to join the Gitea Discord server in case you have questions. There is also a develop channel.

GiteaMirror commented

@pratik9315 commented on GitHub (Jul 4, 2022):

Hey there! So, I checked and as far as I know, the recommended way to have an Profile readme for Organizations is through .github repositories.
So, the first step would be to create an .github repository for gitea.
I did not find a .github repo in our org. If you guys don't mind, I could create a .github repo and then transfer the ownership to the gitea organization. and then work my way through to add profile readme and other related stuff. What'd you think?😁

@pratik9315 commented on GitHub (Jul 4, 2022): Hey there! So, I checked and as far as I know, the recommended way to have an Profile readme for Organizations is through .github repositories. So, the first step would be to create an .github repository for gitea. I did not find a .github repo in our org. If you guys don't mind, I could create a .github repo and then transfer the ownership to the gitea organization. and then work my way through to add profile readme and other related stuff. What'd you think?😁

GiteaMirror commented

@jolheiser commented on GitHub (Jul 4, 2022):

@pratik2315 this proposal is for implementing profile readme in Gitea, not on GitHub for Gitea.

@jolheiser commented on GitHub (Jul 4, 2022): @pratik2315 this proposal is for implementing profile readme _in_ Gitea, not on GitHub _for_ Gitea.

GiteaMirror commented

@pratik9315 commented on GitHub (Jul 4, 2022):

@pratik2315 this proposal is for implementing profile readme in Gitea, not on GitHub for Gitea.

Well technically the profile readme will be in gitea. and will be displayed in Gitea org.
But I may be misunderstanding something😅 Can you pls elaborate more.

@pratik9315 commented on GitHub (Jul 4, 2022): > @pratik2315 this proposal is for implementing profile readme _in_ Gitea, not on GitHub _for_ Gitea. Well technically the profile readme will be in gitea. and will be displayed in Gitea org. But I may be misunderstanding something😅 Can you pls elaborate more.

GiteaMirror commented

@pratik9315 commented on GitHub (Jul 4, 2022):

Im talking about implementing something like this:

.github repo: https://github.com/asyncapi/.github
organisation profile: https://github.com/asyncapi

@pratik9315 commented on GitHub (Jul 4, 2022): Im talking about implementing something like this: .github repo: https://github.com/asyncapi/.github organisation profile: https://github.com/asyncapi

GiteaMirror commented

@jolheiser commented on GitHub (Jul 4, 2022):

Yes, but implementing that in Gitea, the software.

Example:
.gitea repo: https://gitea.com/gitea/.gitea
Org profile: https://gitea.com/gitea

Note that the former will 404 because that's what this proposal is for, being able to display that content in the first place.

@jolheiser commented on GitHub (Jul 4, 2022): Yes, but implementing that in Gitea, the software. Example: .gitea repo: https://gitea.com/gitea/.gitea Org profile: https://gitea.com/gitea Note that the former will 404 because that's what this proposal is for, being able to display that content in the first place.

GiteaMirror commented

@pratik9315 commented on GitHub (Jul 4, 2022):

ahh! seems like i completely misunderstood what this proposal was about😅

@pratik9315 commented on GitHub (Jul 4, 2022): ahh! seems like i completely misunderstood what this proposal was about😅

GiteaMirror commented

@Tech1k commented on GitHub (Jul 28, 2022):

I would really love to see this be implemented! :D

@Tech1k commented on GitHub (Jul 28, 2022): I would really love to see this be implemented! :D

GiteaMirror commented

@twisted-nematic57 commented on GitHub (Sep 10, 2022):

Oh yes, this is necessary. +1

@twisted-nematic57 commented on GitHub (Sep 10, 2022): Oh yes, this is necessary. +1

GiteaMirror commented

@arlcrow commented on GitHub (Oct 21, 2022):

+1

@arlcrow commented on GitHub (Oct 21, 2022): +1

GiteaMirror commented

@goodevilgenius commented on GitHub (Jan 2, 2023):

Implementation-wise, I think calling it username/.profile would be better than username/username or username/.gitea.

Problems with the former have already been mentioned. For the latter, I just think something more neutral than .gitea would be better.

Additionally, this could be the basis for future features, as GitHub allows an org to put org-wide issue templates in this repo also. Something like that might be a useful feature in the future.

@goodevilgenius commented on GitHub (Jan 2, 2023): Implementation-wise, I think calling it `username/.profile` would be better than `username/username` or `username/.gitea`. Problems with the former have already been mentioned. For the latter, I just think something more neutral than `.gitea` would be better. Additionally, this could be the basis for future features, as GitHub allows an org to put org-wide issue templates in this repo also. Something like that might be a useful feature in the future.

GiteaMirror commented

@CodeDoctorDE commented on GitHub (Jan 5, 2023):

I'm currently trying to implement this :)
I post my pull request here if I'm finished

@CodeDoctorDE commented on GitHub (Jan 5, 2023): I'm currently trying to implement this :) I post my pull request here if I'm finished

GiteaMirror commented

@npease18 commented on GitHub (Mar 2, 2023):

Do we like something to the effect of this? I am starting to work on this preliminarily.

@npease18 commented on GitHub (Mar 2, 2023): Do we like something to the effect of this? I am starting to work on this preliminarily. ![image](https://user-images.githubusercontent.com/34464552/222326657-9c35886c-32a1-4b4a-b3ae-85a7bea551b9.png)

GiteaMirror commented

@twisted-nematic57 commented on GitHub (Mar 2, 2023):

@LAX18 I suppose the message could be a bit more descriptive...

How about "{username}/.profile's README.md will be displayed here."

@twisted-nematic57 commented on GitHub (Mar 2, 2023): @LAX18 I suppose the message could be a bit more descriptive... How about "`{username}/.profile`'s README.md will be displayed here."

GiteaMirror commented

@npease18 commented on GitHub (Mar 2, 2023):

I was meaning more about the placement. Eventually it won't be visible at all if there is not a username/.profile repository. As per Github's approach AFAIK

@npease18 commented on GitHub (Mar 2, 2023): I was meaning more about the placement. Eventually it won't be visible at all if there is not a ```username/.profile``` repository. As per Github's approach AFAIK

GiteaMirror commented

@twisted-nematic57 commented on GitHub (Mar 2, 2023):

Yeah, the placement is good.

@twisted-nematic57 commented on GitHub (Mar 2, 2023): Yeah, the placement is good.

GiteaMirror commented