Migrate to Netlify Today

Netlify announces the next evolution of Gatsby Cloud. Learn more

ContactSign Up
Community Plugin
View plugin on GitHub

gatsby-remark-containers

Gatsby.js Remark plugin wrapper for remark-containers.

Provides parsing for ::: delimited containers to wrap markdown blocks in arbitrary html. This snippet:

::: aside
# Header One

With container contents.
:::

Results in:

<aside>
  <h1>Header One</h1>
  <p>With container contents.</p>
</aside>

Install

npm install --save gatsby-remark-containers

Usage

In your gatsby-config.js:

plugins: [
  {
    resolve: 'gatsby-transformer-remark',
    options: {
      plugins: [
        'gatsby-remark-containers'
      ],
    },
  },
];

Test + Cover

npm test

License

MIT

© 2023 Gatsby, Inc.