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

enhancement: Add GitHub style admonitions #849

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

CuB3y0nd
Copy link
Contributor

@CuB3y0nd CuB3y0nd commented Feb 9, 2024

Imitating GitHub Admonitions implement the following effects:

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.

Syntax in mdx:

<Note>
  Highlights information that users should take into account, even when skimming.
</Note>

<Tip>
  Optional information to help a user be more successful.
</Tip>

<Important>
  Crucial information necessary for users to succeed.
</Important>

<Warning>
  Critical content demanding immediate user attention due to potential risks.
</Warning>

<Caution>
  Negative potential consequences of an action.
</Caution>

Copy link

vercel bot commented Feb 9, 2024

Someone is attempting to deploy a commit to a Personal Account owned by @timlrx on Vercel.

@timlrx first needs to authorize it.

@CuB3y0nd CuB3y0nd changed the title Add GitHub style admonitions enhancement: Add GitHub style admonitions Feb 9, 2024
@brohvis
Copy link

brohvis commented Feb 29, 2024

I am so happy I looked in PR's before I went and did this myself. Will definitely use this as a starting point. Cheers!

@timlrx
Copy link
Owner

timlrx commented Mar 31, 2024

Thanks for the contribution, I think it looks great! My preference would be to introduce this feature as a new remark plugin, similar to https://docusaurus.io/docs/markdown-features/admonitions

@CuB3y0nd
Copy link
Contributor Author

CuB3y0nd commented Apr 4, 2024

Thanks for the contribution, I think it looks great! My preference would be to introduce this feature as a new remark plugin, similar to https://docusaurus.io/docs/markdown-features/admonitions

Looking forward to seeing it soon!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants