README.md

Gatsby Theme Carbon Starter

What is this?

Gatsby themes encapsulate all of the configuration and implementation details of Gatsby websites. This is a starter-kit (boilerplate) with a dependancy on the gatsby-theme-carbon package. The primary goal of gatsby-theme-carbon is to get content authors speaking the IBM Design Language with Carbon as soon as possible. It includes some sample components/content demos in the src/pages directory.

How do I use it?

Check out our quick getting started guide and video!

gatsby-theme-carbon at it’s core relies on mdx for page creation. Check out the src/pages directory for some examples for using mdx.

A key feature of Gatsby themes is component shadowing. By simply placing a component into the src/gatsby-theme-carbon/components location, you can override components used by the theme. You can read more about component shadowing here.

You’re also free to make your own components and use them in your MDX pages.

What’s Next?

Check out the docs!