diff options
| author | Nicholas Pease <34464552+LAX18@users.noreply.github.com> | 2023-05-09 01:57:24 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-05-09 05:57:24 +0000 |
| commit | c090f87a8db5b51e0aa9c7278b38ddc862c048ac (patch) | |
| tree | b3c81f50f1392dcfcaebe2ae0ea09dd3e74ac384 /docs/content/doc/usage | |
| parent | b6fc2cdf82acc9792a3607dc4afba93f03fff9d7 (diff) | |
| download | gitea-c090f87a8db5b51e0aa9c7278b38ddc862c048ac.tar.gz gitea-c090f87a8db5b51e0aa9c7278b38ddc862c048ac.zip | |
Add Gitea Profile Readmes (#23260)
Implements displaying a README.md file present in a users ```.profile```
repository on the users profile page. If no such repository/file is
present, the user's profile page remains unchanged.
Example of user with ```.profile/README.md```
Example of user without ```.profile/README.md```
This pull request closes the feature request in #12233
Special thanks to @techknowlogick for the help in the Gitea discord!
---------
Co-authored-by: techknowlogick <techknowlogick@gitea.io>
Co-authored-by: Yarden Shoham <hrsi88@gmail.com>
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-authored-by: yp05327 <576951401@qq.com>
Co-authored-by: Yarden Shoham <git@yardenshoham.com>
Diffstat (limited to 'docs/content/doc/usage')
| -rw-r--r-- | docs/content/doc/usage/profile-readme.en-us.md | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/docs/content/doc/usage/profile-readme.en-us.md b/docs/content/doc/usage/profile-readme.en-us.md new file mode 100644 index 0000000000..802451f0b6 --- /dev/null +++ b/docs/content/doc/usage/profile-readme.en-us.md @@ -0,0 +1,20 @@ +--- +date: "2023-03-02T21:00:00+05:00" +title: "Usage: Gitea Profile READMEs" +slug: "profile-readme" +weight: 12 +toc: false +draft: false +menu: + sidebar: + parent: "usage" + name: "Gitea Profile READMEs" + weight: 12 + identifier: "profile-readme" +--- + +# Gitea Profile READMEs + +To display a markdown file in your Gitea profile page, simply make a repository named ".profile" and edit the README.md file inside. Gitea will automatically pull this file in and display it above your repositories. + +Note. You are welcome to make this repository private. Doing so will hide your source files from public viewing and allow you to privitize certain files. However, the README.md file will be the only file present on your profile. If you wish to have an entirely private .profile repository, remove or rename the README.md file. |