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

support markdown alerts in documentation page #31318

Open
kaizencc opened this issue Sep 4, 2024 · 0 comments
Open

support markdown alerts in documentation page #31318

kaizencc opened this issue Sep 4, 2024 · 0 comments
Labels
bug This issue is a bug. documentation This is a problem with documentation. effort/small Small work item – less than a day of effort p3

Comments

@kaizencc
Copy link
Contributor

kaizencc commented Sep 4, 2024

Describe the issue

Markdown has a feature called alerts that are supported natively in GitHub and provide an excellent viewing experience in our GitHub documentation.

However, our documentation page does not support these magic alerts and results in something ok, but not great (search for the raw ![Note] or ![Important].

I think the simplest thing to do here is to just omit the line of ![Note] if it shows up. It's no biggie either way :). I would love to continue using this feature in the GitHub docs and not have to worry about how it looks in our documentation site.

Links

n/a

@kaizencc kaizencc added needs-triage This issue or PR still needs to be triaged. documentation This is a problem with documentation. p3 bug This issue is a bug. effort/small Small work item – less than a day of effort and removed needs-triage This issue or PR still needs to be triaged. labels Sep 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug This issue is a bug. documentation This is a problem with documentation. effort/small Small work item – less than a day of effort p3
Projects
None yet
Development

No branches or pull requests

1 participant