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

Update Note and Warning markdown highlighting with GitHub's changes #28316

Closed
yardenshoham opened this issue Dec 1, 2023 · 3 comments · Fixed by #29121
Closed

Update Note and Warning markdown highlighting with GitHub's changes #28316

yardenshoham opened this issue Dec 1, 2023 · 3 comments · Fixed by #29121
Labels
type/proposal The new feature has not been accepted yet but needs to be discussed first.

Comments

@yardenshoham
Copy link
Member

yardenshoham commented Dec 1, 2023

Feature Description

Since July 21st, GitHub has made a few changes to their feature. We introduced it into Gitea with #21711. Now we need to update the implementation to match GitHub's, including a syntax change. An example of the current implementation on GitHub:

Note

Highlights information that users should take into account, even when skimming.

Tip

Optional information to help a user be more successful.

Important

Crucial information necessary for users to succeed.

Warning

Critical content demanding immediate user attention due to potential risks.

Caution

Negative potential consequences of an action.

Docs: https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts https://github.com/orgs/community/discussions/16925

Screenshots

No response

@yardenshoham yardenshoham added the type/proposal The new feature has not been accepted yet but needs to be discussed first. label Dec 1, 2023
@lng2020
Copy link
Member

lng2020 commented Dec 5, 2023

So, If I understand correctly, GitHub no longer supports

>**NOTE**
>something

Instead, it uses

>[!NOTE]  
>something

That's a breaking change. Should we follow what GitHub did?

@yardenshoham
Copy link
Member Author

I think we should follow GitHub on this feature

lafriks pushed a commit that referenced this issue Feb 10, 2024
- Follows #21711
- Closes #28316

Implement GitHub's alert blocks markdown feature

Docs:
-
https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts
- https://github.com/orgs/community/discussions/16925

### Before

![image](https://github.com/go-gitea/gitea/assets/20454870/14f7b02a-5de5-4fd0-8437-a055dadb31f2)

### After

![image](https://github.com/go-gitea/gitea/assets/20454870/ed06a869-e545-42f1-bf25-4ba20b1be196)

## ⚠️ BREAKING ⚠️

The old syntax no longer works

How to migrate:

If you used
```md
> **Note** My note
```

Switch to
```md
> [!NOTE]
> My note
```

---------

Signed-off-by: Yarden Shoham <[email protected]>
Co-authored-by: silverwind <[email protected]>
Co-authored-by: Giteabot <[email protected]>
DennisRasey pushed a commit to DennisRasey/forgejo that referenced this issue Feb 18, 2024
- Follows go-gitea/gitea#21711
- Closes go-gitea/gitea#28316

Implement GitHub's alert blocks markdown feature

Docs:
-
https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts
- https://github.com/orgs/community/discussions/16925

### Before

![image](https://github.com/go-gitea/gitea/assets/20454870/14f7b02a-5de5-4fd0-8437-a055dadb31f2)

### After

![image](https://github.com/go-gitea/gitea/assets/20454870/ed06a869-e545-42f1-bf25-4ba20b1be196)

## ⚠️ BREAKING ⚠️

The old syntax no longer works

How to migrate:

If you used
```md
> **Note** My note
```

Switch to
```md
> [!NOTE]
> My note
```

---------

Signed-off-by: Yarden Shoham <[email protected]>
Co-authored-by: silverwind <[email protected]>
Co-authored-by: Giteabot <[email protected]>
silverwind added a commit to silverwind/gitea that referenced this issue Feb 20, 2024
- Follows go-gitea#21711
- Closes go-gitea#28316

Implement GitHub's alert blocks markdown feature

Docs:
-
https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts
- https://github.com/orgs/community/discussions/16925

### Before

![image](https://github.com/go-gitea/gitea/assets/20454870/14f7b02a-5de5-4fd0-8437-a055dadb31f2)

### After

![image](https://github.com/go-gitea/gitea/assets/20454870/ed06a869-e545-42f1-bf25-4ba20b1be196)

## ⚠️ BREAKING ⚠️

The old syntax no longer works

How to migrate:

If you used
```md
> **Note** My note
```

Switch to
```md
> [!NOTE]
> My note
```

---------

Signed-off-by: Yarden Shoham <[email protected]>
Co-authored-by: silverwind <[email protected]>
Co-authored-by: Giteabot <[email protected]>
Copy link

Automatically locked because of our CONTRIBUTING guidelines

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 28, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
type/proposal The new feature has not been accepted yet but needs to be discussed first.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants