Does markdown rendering work on repo's description? #14509

New Issue

GiteaMirror · 2025-11-02T11:14:54-06:00

GiteaMirror commented

2025-11-02 11:14:54 -06:00

Originally created by @develoopeer on GitHub (May 20, 2025).

Description

What is this issue about

There is already closed issue Markdown for repo's description about this feature and it was closed as completed but without any PR mentioned or even any comments about decision that was made.

Nowadays nothing seems to work - Markdown is not being rendered in repo description and i want to ask.
Was this feature implemented or closed as rejected. If it wasn't rejected, please let me know if there are any plans to implement it. Also i want to contribute in Gitea that's why i can implement it myself.

Thanks for software you make 👍

Gitea Version

0534eddd16

Can you reproduce the bug on the Gitea demo site?

Yes

Log Gist

No response

Screenshots

No response

Git Version

No response

Operating System

No response

How are you running Gitea?

docker compose file

Database

None

Originally created by @develoopeer on GitHub (May 20, 2025). ### Description ## What is this issue about There is already closed issue [Markdown for repo's description](https://github.com/go-gitea/gitea/issues/3645) about this feature and it was closed as completed but without any PR mentioned or even any comments about decision that was made. Nowadays nothing seems to work - *Markdown is not being rendered* in repo description and i want to ask. Was this feature implemented or closed as rejected. If it wasn't rejected, please let me know if there are any plans to implement it. Also i want to contribute in Gitea that's why i can implement it myself. Thanks for software you make 👍 ### Gitea Version 0534eddd16a604fabfec464e36458e540244382d ### Can you reproduce the bug on the Gitea demo site? Yes ### Log Gist _No response_ ### Screenshots _No response_ ### Git Version _No response_ ### Operating System _No response_ ### How are you running Gitea? docker compose file ### Database None

GiteaMirror added the type/proposal type/docs issue/not-a-bug labels 2025-11-02 11:14:54 -06:00

GiteaMirror commented

2025-11-02 11:14:55 -06:00

@lunny commented on GitHub (May 20, 2025):

Currently, repository description support three render formats.

		descriptionLinkProcessor,
		emojiShortCodeProcessor,
		emojiProcessor,

@lunny commented on GitHub (May 20, 2025): Currently, repository description support three render formats. ``` descriptionLinkProcessor, emojiShortCodeProcessor, emojiProcessor, ```

GiteaMirror commented

2025-11-02 11:14:55 -06:00

@silverwind commented on GitHub (May 21, 2025):

What markdown features are you missing? I think repo description falls under the category that only a limited subset of markdown features can be supported. We should keep it strictly compatible to what GitHub allows so that repos remain portable.

@silverwind commented on GitHub (May 21, 2025): What markdown features are you missing? I think repo description falls under the category that only a limited subset of markdown features can be supported. We should keep it strictly compatible to what GitHub allows so that repos remain portable.

GiteaMirror commented

2025-11-02 11:14:55 -06:00

@develoopeer commented on GitHub (May 22, 2025):

That makes sense. I hadn't thought about this problem that way. As far as i know neither Github nor Gitlab allow users to render markdown in description, but i really miss the ability to create links, short links to be more specific.

Example:

Name: Repository Fork
Description: Fork of [repo](http://github.com/owner/repo)

This of course can be rewritten this way:

Name: Repository Fork
Description: Fork of repo
Link: http://github.com/owner/repo

But as i can see Gitea already knows that the link was passed to description, and will add nice <a></a> tag:

How it looks without hover:

With hover:

Maybe the solution i really need is to remain the value of tag href but change the body
With that i can simply change this:

<a href="https://github.com/0x2E/fusion" target="_blank" rel="noopener noreferrer nofollow">https://github.com/0x2E/fusion</a>

To this:

<a href="https://github.com/0x2E/fusion" target="_blank" rel="noopener noreferrer nofollow">0x2E/fusion</a>

Result:

Is this behavior easy to achieve or it will take a lot of effort ?

@develoopeer commented on GitHub (May 22, 2025): That makes sense. I hadn't thought about this problem that way. As far as i know neither Github nor Gitlab allow users to render markdown in description, but i really miss the ability to create links, short links to be more specific. Example: ```markdown Name: Repository Fork Description: Fork of [repo](http://github.com/owner/repo) ``` This of course can be rewritten this way: ```markdown Name: Repository Fork Description: Fork of repo Link: http://github.com/owner/repo ``` But as i can see Gitea already knows that the link was passed to description, and will add nice `<a></a>` tag: How it looks without hover: ![Image](https://github.com/user-attachments/assets/7516fe09-9ca9-487c-a80a-08d4dc94ecb2) With hover: ![Image](https://github.com/user-attachments/assets/041dcea3-cf99-4d1f-8426-f065e93fa82f) Maybe the solution i really need is to remain the value of tag `href` but change the body With that i can simply change this: ```html <a href="https://github.com/0x2E/fusion" target="_blank" rel="noopener noreferrer nofollow">https://github.com/0x2E/fusion</a> ``` To this: ```html <a href="https://github.com/0x2E/fusion" target="_blank" rel="noopener noreferrer nofollow">0x2E/fusion</a> ``` Result: ![Image](https://github.com/user-attachments/assets/2fb71063-5ad7-4b46-8424-dcbd0b69fde8) ![Image](https://github.com/user-attachments/assets/d816b6c6-6e48-47a2-8a3b-cd9be03b4666) Is this behavior easy to achieve or it will take a lot of effort ?

GiteaMirror commented

2025-11-02 11:14:55 -06:00

@silverwind commented on GitHub (May 22, 2025):

I see, so basically you want to be able to have a different link text and url.

It's a reasonable request, but I don't think we should implement it because it would break compatibilty with GitHub/GitLab. For example when you migrate a repo from Gitea to them, the rendering would no longer work.

@silverwind commented on GitHub (May 22, 2025): I see, so basically you want to be able to have a different link text and url. It's a reasonable request, but I don't think we should implement it because it would break compatibilty with GitHub/GitLab. For example when you migrate a repo from Gitea to them, the rendering would no longer work.

GiteaMirror commented

2025-11-02 11:14:55 -06:00

@lunny commented on GitHub (May 22, 2025):

Just put the link itself will resolve the problem. like This is the description https://github.com/0x2E/fusion.

@lunny commented on GitHub (May 22, 2025): Just put the link itself will resolve the problem. like `This is the description https://github.com/0x2E/fusion`.

GiteaMirror commented

2025-11-02 11:14:55 -06:00

@develoopeer commented on GitHub (May 23, 2025):

I don't get it. Where to put the link itself so that it solves the problem. If i put:

This is the description https://github.com/0x2E/fusion

in the description, Gitea will render the full link.But i want to shorten it like you can do with following markdown:

This is the [0x2E/fusion](https://github.com/0x2E/fusion)

@develoopeer commented on GitHub (May 23, 2025): I don't get it. Where to put the link itself so that it solves the problem. If i put: ```mardown This is the description https://github.com/0x2E/fusion ``` in the description, Gitea will render the full link.But i want to shorten it like you can do with following markdown: ```mardown This is the [0x2E/fusion](https://github.com/0x2E/fusion) ```

GiteaMirror commented

2025-11-02 11:14:56 -06:00

@lunny commented on GitHub (May 23, 2025):

Unfortunately, the second option is not yet supported, and GitHub does not support it either.

@lunny commented on GitHub (May 23, 2025): Unfortunately, the second option is not yet supported, and GitHub does not support it either.

Sign in to join this conversation.

Branches Tags

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: github-starred/gitea#14509