https://github.com/carbon-design-system/gatsby-starter-carbon-theme

A Gatsby starter demonstrating the Gatsby Carbon theme
https://github.com/carbon-design-system/gatsby-starter-carbon-theme

Last synced: 4 months ago
JSON representation

A Gatsby starter demonstrating the Gatsby Carbon theme

• Host: GitHub
• URL: https://github.com/carbon-design-system/gatsby-starter-carbon-theme
• Owner: carbon-design-system
• License: apache-2.0
• Created: 2019-04-24T02:34:34.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2021-10-07T23:17:18.000Z (about 3 years ago)
• Last Synced: 2024-04-27T02:33:46.363Z (7 months ago)
• Language: JavaScript
• Size: 30.6 MB
• Stars: 18
• Watchers: 9
• Forks: 24
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-ibmcloud - gatsby-starter-carbon-theme - A Gatsby starter demonstrating the Gatsby Carbon theme. (Carbon Design System)

README

        
# Gatsby Theme Carbon Starter

## What is this?

> Gatsby [themes](https://www.gatsbyjs.org/docs/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](https://gatsby-theme-carbon.now.sh/getting-started) guide and

video!

`gatsby-theme-carbon` at it’s core relies on [mdx](https://mdxjs.com/) 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](https://www.gatsbyjs.org/docs/themes/api-reference#component-shadowing).

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

## What’s Next?

[Check out the docs!](https://gatsby-theme-carbon.now.sh)