You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

History

Michael Fix 9fae764e77 Update README.md		6 years ago
..
README.md	Update README.md	6 years ago
index.js	add gatsby-remark-embed-carbon package (#537 )	6 years ago
package.json	add gatsby-remark-embed-carbon package (#537 )	6 years ago
yarn.lock	add gatsby-remark-embed-carbon package (#537 )	6 years ago

README.md

gatsby-remark-embed-carbon

Embed Carbon screenshots in your markdown files

Getting started

Install plugin to your site:

yarn add gatsby-remark-embed-carbon

Add gatsby-remark-embed-carbon to your gatsby-transformer-remark plugins in gatsby-config.js:

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

Configuration

plugins: [
  {
    resolve: 'gatsby-transformer-remark',
    options: {
      plugins: [
        {
          resolve: 'gatsby-remark-embed-carbon',
          options: {
            width: '100%', // default is '1024px'
            height: '600px' // default is '473px'
          }
        }
      ]
    }
  }
]

Example

Add a carbon screenshot directly in your markdown file:

# Blog Post

This link will get replaced with a Carbon iframe:

https://carbon.now.sh/?bg=red

Thanks

This project was completely inspired by (copied from) @garetmckinley's gatsby-remark-embed-spotify ⭐