-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
fix(core/bootstrap): use correct GitHub alert syntax with empty line separator #2236
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
fix(core/bootstrap): use correct GitHub alert syntax with empty line separator #2236
Conversation
Co-authored-by: vinceAmstoutz <46444652+vinceAmstoutz@users.noreply.github.com>
vinceAmstoutz
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
core/bootstrap.md
Outdated
|
|
||
| > [!NOTE] | ||
| > This documentation is a work in progress we're working on improving it, in the mean time | ||
| > [!NOTE] This documentation is a work in progress we're working on improving it, in the mean time |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
no, refer to the official doc:
Alerts, also sometimes known as callouts or admonitions, are a Markdown extension based on the blockquote syntax that you can use to emphasize critical information. On GitHub, they are displayed with distinctive colors and icons to indicate the significance of the content.
Use alerts only when they are crucial for user success and limit them to one or two per article to prevent overloading the reader. Additionally, you should avoid placing alerts consecutively. Alerts cannot be nested within other elements.
To add an alert, use a special blockquote line specifying the alert type, followed by the alert information in a standard blockquote. Five types of alerts are available:
Note
Useful information that users should know, even when skimming content.
Tip
Helpful advice for doing things better or more easily.
Important
Key information users need to know to achieve their goal.
Warning
Urgent info that needs immediate user attention to avoid problems.
Caution
Advises about risks or negative outcomes of certain actions.
| > [!NOTE] This documentation is a work in progress we're working on improving it, in the mean time | |
| > [!NOTE] | |
| > This documentation is a work in progress we're working on improving it, in the mean time |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed in 6e4e398. Applied the correct GitHub alert syntax with [!NOTE] on its own line followed by an empty blockquote line, matching the format used in other files like symfony/debugging.md. This passes all linters (Prettier, markdownlint, proselint) and follows the official GitHub alert documentation.
Co-authored-by: vinceAmstoutz <46444652+vinceAmstoutz@users.noreply.github.com>
8d86d13
into
fix/core-bootstrap-note-formatting
* fix(core/bootstrap): note formatting * fix(core/bootstrap): use correct GitHub alert syntax with empty line separator (#2236) * Initial plan * fix: apply prettier formatting to bootstrap.md Co-authored-by: vinceAmstoutz <46444652+vinceAmstoutz@users.noreply.github.com> * fix: use correct GitHub alert syntax with empty line separator Co-authored-by: vinceAmstoutz <46444652+vinceAmstoutz@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: vinceAmstoutz <46444652+vinceAmstoutz@users.noreply.github.com> --------- Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>
Fixes the GitHub alert syntax in
core/bootstrap.mdto follow the official GitHub documentation for alerts.Changes:
[!NOTE]on its own line>) between[!NOTE]and the contentBefore:
After:
This format:
symfony/debugging.md✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.