docker / build-push-action

GitHub Action to build and push Docker images with Buildx
https://github.com/marketplace/actions/build-and-push-docker-images
Apache License 2.0
4.24k stars 541 forks source link

readme: update note/warning highlight syntax #912

Closed andros21 closed 1 year ago

andros21 commented 1 year ago

see https://github.com/orgs/community/discussions/16925#discussioncomment-6506860

The previous syntax should be supported for a certain period of time. However a break space must be added between Note or Warning and first sentence. For example:

Important

This doesn't work

Important \ This works

This PR updates the two block quotes in README to use directly the new syntax:

[!IMPORTANT] \ This works (new syntax)

andros21 commented 1 year ago

Btw note/warning blocks in README are rendered correctly now So free to stay with the previous syntax that seems to work again

crazy-max commented 1 year ago

Btw note/warning blocks in README are rendered correctly now So free to stay with the previous syntax that seems to work again

Yes looks like they rollbacked. Let's keep it like this for now but thanks for your input!