maeffew / gatsby-starter-carbon-theme

A Gatsby starter demonstrating the Gatsby Carbon theme

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Gatsby Theme Carbon Starter

What is this?

Gatsby has implemented a new feature called themes. Themes encapsulate all of the configuration and implementation details of Gatsby websites. This is a starter-kit (boilerplate) that has a dependancy on the gatsby-theme-carbon package. It includes some sample content in the src/pages directory.

What’s included?

  • Carbon Elements and Carbon React
  • Emotion for React component styling
  • gatsby-mdx with brand new markdown components

How do I use it?

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?

  • Migrating reusable MDX components
  • Parameters to configure Carbon theme

About

A Gatsby starter demonstrating the Gatsby Carbon theme

License:Apache License 2.0


Languages

Language:JavaScript 97.3%Language:CSS 2.7%