search

timlrx / tailwind-nextjs-starter-blog

This is a Next.js, Tailwind CSS blogging starter template. Comes out of the box configured with the latest technologies to make technical writing a breeze. Easily configurable and customizable. Perfect as a replacement to existing Jekyll and Hugo individual blogs.
https://tailwind-nextjs-starter-blog.vercel.app/
MIT License
8.45k stars 1.96k forks source link

enhancement: Add GitHub style admonitions #849

Closed CuB3y0nd closed 2 months ago

CuB3y0nd commented 6 months ago

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>
vercel[bot] commented 6 months ago

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

@timlrx first needs to authorize it.

brohvis commented 6 months ago

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 commented 5 months ago

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 commented 5 months ago

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!