Skip to content
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

Don't use <br /> in alert block #29650

Merged
merged 5 commits into from
Mar 8, 2024
Merged

Conversation

yardenshoham
Copy link
Member

@yardenshoham yardenshoham commented Mar 7, 2024

When I implemented alert blocks I was always testing the markdown in issue comments. I used <br /> for line breaks and it looked good. I have since learned that the markdown on README files doesn't allow these tags. So a comment with

> [!NOTE]
> If you're interested in using our APIs, we have experimental support with [documentation](https://try.gitea.io/api/swagger).

looked like this in a comment
image
but looked like this in a README
image

So I changed how we render the alert block by having the alert itself have a dedicated paragraph, so line breaks happen naturally between paragraphs.

Before

image
image

After

image
image

When I implemented alert blocks I was always testing the markdown in issue comments. I used `<br />` for line breaks and it looked good. I have since learned that the markdown on README files doesn't allow these tags.

Signed-off-by: Yarden Shoham <git@yardenshoham.com>
@GiteaBot GiteaBot added the lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. label Mar 7, 2024
@pull-request-size pull-request-size bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Mar 7, 2024
@techknowlogick techknowlogick added topic/ui Change the appearance of the Gitea UI type/bug backport/v1.21 This PR should be backported to Gitea 1.21 labels Mar 7, 2024
@yardenshoham yardenshoham added skip-changelog This PR is irrelevant for the (next) changelog, for example bug fixes for unreleased features. type/bug topic/ui Change the appearance of the Gitea UI and removed type/bug topic/ui Change the appearance of the Gitea UI backport/v1.21 This PR should be backported to Gitea 1.21 labels Mar 7, 2024
@yardenshoham
Copy link
Member Author

New alert blocks are only available in 1.22 so no need for backport

@yardenshoham yardenshoham added this to the 1.22.0 milestone Mar 7, 2024
@silverwind
Copy link
Member

Does this new behaviour match GitHub rendering in both comments and .md files?

@yardenshoham
Copy link
Member Author

Yes, this brings us closer to GitHub

@GiteaBot GiteaBot added lgtm/need 1 This PR needs approval from one additional maintainer to be merged. and removed lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. labels Mar 8, 2024
@silverwind Can you update the issue content? Looks like we need to merge issue content and go-gitea#29651 (comment) as the commit message.
@GiteaBot GiteaBot added lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. and removed lgtm/need 1 This PR needs approval from one additional maintainer to be merged. labels Mar 8, 2024
@yardenshoham yardenshoham added the reviewed/wait-merge This pull request is part of the merge queue. It will be merged soon. label Mar 8, 2024
@lunny lunny enabled auto-merge (squash) March 8, 2024 08:13
@lunny lunny merged commit b5c418f into go-gitea:main Mar 8, 2024
26 checks passed
@GiteaBot GiteaBot removed the reviewed/wait-merge This pull request is part of the merge queue. It will be merged soon. label Mar 8, 2024
@yardenshoham yardenshoham deleted the fix-readme branch March 8, 2024 09:31
zjjhot added a commit to zjjhot/gitea that referenced this pull request Mar 8, 2024
* giteaofficial/main:
  Add cache for branch divergence on branch list page (go-gitea#29577)
  Fix user-defined markup links targets (go-gitea#29305)
  Don't show AbortErrors on logout (go-gitea#29639)
  Style fomantic grey labels (go-gitea#29458)
  Don't use `<br />` in alert block (go-gitea#29650)
  Fix incorrect rendering csv file when file size is larger than UI.CSV.MaxFileSize (go-gitea#29653)
  Set user's 24h preference from their current OS locale (go-gitea#29651)
  Move get/set default branch from git package to gitrepo package to hide repopath (go-gitea#29126)
  Make runs-on support variable expression (go-gitea#29468)
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 16, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. skip-changelog This PR is irrelevant for the (next) changelog, for example bug fixes for unreleased features. topic/ui Change the appearance of the Gitea UI type/bug
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants