{"repo":"antfu/markdown-it-github-alerts","free":true,"listed":false,"github":"https://github.com/antfu/markdown-it-github-alerts","clone":"git clone https://github.com/antfu/markdown-it-github-alerts.git","description":"Support GitHub-style alerts for markdown-it","language":"TypeScript","stars":220,"topics":["github-flavored-markdown","markdown","markdown-it"],"license":"MIT","category":"productivity","readme_excerpt":"markdown-it-github-alerts [![npm version][npm-version-src]][npm-version-href] [![npm downloads][npm-downloads-src]][npm-downloads-href] [![bundle][bundle-src]][bundle-href] [![JSDocs][jsdocs-src]][jsdocs-href] [![License][license-src]][license-href] Support GitHub-style alerts for markdown-it. [!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. Usage For the options available, please refer to the jsdoc. Functionality This plugin transforms the following markdown: to the following HTML: Which is compatible with the GitHub's output. Styling You can write your custom styles for your alerts. We also provide some CSS extracted from GitHub's styles for you to use. You might change github-colors-dark-media.css to github-colors-dark-class.css if you are using class-based ( .dark ) dark mode. Refer to the source code for more details. Customization In order to also support Obsidian callouts syntax it is possible to allow any type of markers with the following setting: Alternative titles are also supported, by appending it to the marker like this: Sponsors License MIT License © 2023-PRESENT Anthony Fu [npm-version-src]: https://img.shields.io/npm/v/markdown-it-github-alerts?style=fla","default_branch":null,"files":null,"tree":[],"storefront":"/r/antfu","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/antfu/markdown-it-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."}