gogs / gogs/gogs

Support Admonitions in Markdown render

Open
#8,388 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

🎯 feature
Dominant language
Go
Stars
47.8k
Forks
5.1k
Avg merge
7h 23m
Merged PRs (30d)
5

Description

Describe the feature

Admonitions are supported in several Markdown renders like here in GitHub. It would be nice if Gogs supported it too.

The following tags are currently supported:

> [!NOTE]
> General information or additional context.

> [!TIP]
> A helpful suggestion or best practice.

> [!IMPORTANT]
> Key information that shouldn't be missed.

> [!WARNING]
> Critical information that highlights a potential risk.

> [!CAUTION]
> Information about potential issues that require caution.

And they are rendered this way:

[!NOTE]
General information or additional context.

[!TIP]
A helpful suggestion or best practice.

[!IMPORTANT]
Key information that shouldn't be missed.

[!WARNING]
Critical information that highlights a potential risk.

[!CAUTION]
Information about potential issues that require caution.

Describe the solution you'd like

I just want them to be displayed the same way on Gogs. Right now, they just appear as a blockquote, nothing more:

Sample

Describe alternatives you've considered

There are no magic solutions for this.

Additional context

No response

Code of Conduct
  • I agree to follow this project's Code of Conduct

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No file or test is named in the issue. Start by locating Gogs's Markdown rendering entry point and related tests, then verify that the five listed tags render as admonitions rather than plain blockquotes.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
content
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.