remark-blockquote-alerts

remark-blockquote-alerts extends the functionality of Markdown to enable highlighted blockquotes in environments using remark, such as Gatsby.js and similar frameworks. By default, Markdown in these environments does not support blockquote highlights.

This package supports ESM and CommonJS formats, ensuring compatibility with modern frameworks and Node.js environments.

GitHub introduced this feature in 2022 (see GitHub Discussions), and it has since been widely used in many documents. This library allows you to bring similar functionality to your Markdown-based projects.

How It Works

This library transforms blockquote prefixes into CSS class formats. For example, a blockquote starting with [!NOTE] will be converted to class="blockquote-note". Using CSS, you can style these blockquotes to create elegant components like the example below:

An example of all five types:

> [!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.

Here is how they are displayed:

Installation

npm install remark-blockquote-alerts

You can also install using pnpm or yarn.

Usage

Basic Usage

import remarkAlerts from 'remark-blockquote-alerts';

const markdown = '> [!NOTE] Highlights information that users should take into account, even when skimming.';

const result = remark()
  .use(remarkAlerts)
  .use(remarkRehype)
  .use(rehypeStringify)
  .processSync(markdown).toString();

This output will be:

<blockquote class="blockquote-note">
  <p>Highlights information that users should take into account, even when skimming.</p>
</blockquote>

Using with Gatsby.js

To use remark-blockquote-alerts in a Gatsby.js project, you can integrate it with gatsby-plugin-mdx by extending its Remark plugins configuration.

// gatsby-config.js

import remarkAlerts from 'remark-blockquote-alerts';

const config: GatsbyConfig = {
  plugins: [
    {
      resolve: 'gatsby-plugin-mdx',
      options: {
        mdxOptions: {
          remarkPlugins: [remarkAlerts],
        },
      },
    },
  ],
};

Styling

To apply the default styles shown in the examples, simply import:

import "remark-blockquote-alerts/styles/blockquote.min.css";

If you'd like to customize the styles, you can copy and modify the file:

remark-blockquote-alerts/styles/blockquote.css

Contributing

We welcome all contributions! You can open an issue to report bugs or suggest features, and submit a pull request to contribute directly to the codebase.

License

This project is distributed under the MIT License. For more information, see the LICENSE file.

Contact

If you have any questions, feel free to reach out via Issues or contact me directly at [email protected].