# gatsby-theme-carbon-starter

> ## What is this?

Latest version **0.0.7** (published 2019-04-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install gatsby-theme-carbon-starter
pnpm add gatsby-theme-carbon-starter
yarn add gatsby-theme-carbon-starter
bun add gatsby-theme-carbon-starter
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.7 |
| Published | 2019-04-23 |
| First published | 2019-04-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 2.2 MB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | vpicone |
| Maintainers | vpicone |

## Links

- npm: https://www.npmjs.com/package/gatsby-theme-carbon-starter
- Repository: https://github.com/carbon-design-system/gatsby-theme-carbon
- Homepage: https://github.com/carbon-design-system/gatsby-theme-carbon#readme
- Issues: https://github.com/carbon-design-system/gatsby-theme-carbon/issues
- npm.io page: https://npm.io/package/gatsby-theme-carbon-starter

## Dependencies (4)

- [react](https://npm.io/package/react.md) ^16.8.6
- [gatsby](https://npm.io/package/gatsby.md) ^2.3.5
- [react-dom](https://npm.io/package/react-dom.md) ^16.8.6
- [gatsby-theme-carbon](https://npm.io/package/gatsby-theme-carbon.md) ^0.0.7

## Recent versions

- 0.0.7 (latest) — 2019-04-23
- 0.0.6 — 2019-04-23
- 0.0.5 — 2019-04-23
- 0.0.4 — 2019-04-23
- 0.0.3 — 2019-04-23
- 0.0.2 — 2019-04-15
- 0.0.1 — 2019-04-15

## README

# Gatsby Theme Carbon Starter

## What is this?

> Gatsby has implemented a new feature called [themes](https://www.gatsbyjs.org/docs/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-carbon-theme` package. It includes some sample content in the `src/pages` directory.

## What's included?

- Carbon Elements and Carbon React
- [Emotion](https://emotion.sh) for React component styling
- [gatsby-mdx](https://gatsby-mdx.netlify.com/) with brand new markdown components

## How do I use it?

`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?

- Migrating reusable MDX components
- Parameters to configure Carbon theme

---
_Source: https://npm.io/package/gatsby-theme-carbon-starter · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._