{"repo":"chrisweb/rehype-github-alerts","free":true,"listed":false,"github":"https://github.com/chrisweb/rehype-github-alerts","clone":"git clone https://github.com/chrisweb/rehype-github-alerts.git","description":"rehype plugin to create alerts (admonitions/callouts) ⚠️, mimicking the way alerts get rendered on github.com","language":"TypeScript","stars":36,"topics":["admonitions","alerts","callouts","github","hast","rehype","rehype-plugin","markdown","mdx","typescript"],"license":"MIT","category":"productivity","readme_excerpt":"rehype-github-alerts Introduction rehype plugin to create alerts (admonitions/callouts), mimicking the way alerts get rendered on github.com (based on this GitHub community \"Alerts\" discussion), currently 5 types of alerts are supported: [!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. the markdown syntax for the 5 examples above is as follows: this is a zero configuration package as all options have defaults, but you can use them if you wish to modify default behavior, like for example by default 5 alerts are defined (with a default icon for each), use options.alerts to replace them with your own setup, there is also a default build that will create an HTML output that mimics what GitHub does, but you can change the build to create whatever HTML suits your needs best, check out the \"options\" chapter to learn more about customization installation To install rehype-github-alerts: examples Rehype example For a simple example have a look at the \"rehype example\" README (the source code is located in examples/simple-rehype-example/ ) Next.js tutorial I published a Next.js Next.js MDX tutorial on my blog, the tutorial has a page about using the rehype-github-alerts plugin with","default_branch":null,"files":null,"tree":[],"storefront":"/r/chrisweb","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/chrisweb/rehype-github-alerts/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}