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 for common markdown callouts like NOTE, TIP, HINT #489

Closed
4 tasks done
KingOfSpades opened this issue Jan 17, 2022 · 1 comment
Closed
4 tasks done

Support for common markdown callouts like NOTE, TIP, HINT #489

KingOfSpades opened this issue Jan 17, 2022 · 1 comment
Labels
enhancement New feature or request
Milestone

Comments

@KingOfSpades
Copy link

Checklist

Is your feature request related to a problem? Please describe

No

Describe the solution you'd like

Support for callouts (sometimes called alerts or admonitions) that set off their contents visually. For example, NOTE, WARN or INFO could wrap the content that follows in a yellow, red or blue container, and/or change the font color.

This has been implemented on the theme "just-the-docs" in the following style: https://pdmosses.github.io/just-the-docs-tests/docs/css/admonitions.html

Describe alternatives you've considered

The alternative I'am currently using is in the form of the following code:
For a warning:

<div markdown="span" class="alert alert-danger" role="alert"><i class="fa fa-exclamation-circle"></i> <b>Warning:</b> Mounting a volume on path that already exists on a pod will make all files in that directory inaccessible</b>
</div>

Renders to:

  • Light mode:
    image

  • Dark mode:
    image

Additional context

@KingOfSpades KingOfSpades added the enhancement New feature or request label Jan 17, 2022
@cotes2020 cotes2020 added this to the 5.1.0 milestone Jan 21, 2022
cotes2020 added a commit that referenced this issue Jan 22, 2022
@aphive aphive mentioned this issue Feb 11, 2022
3 tasks
@KingOfSpades
Copy link
Author

Awesome!

dkbnz pushed a commit to dkbnz/jekyll-theme-chirpy that referenced this issue Jul 12, 2022
shihtiy-tw pushed a commit to shihtiy-tw/shihtiy-tw.github.io that referenced this issue Nov 26, 2022
sanjidnet pushed a commit to sanjidnet/sanjidnet.github.io that referenced this issue Jan 9, 2023
Ap3x pushed a commit to Ap3x/ap3x.github.com that referenced this issue Feb 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants