APACHE-2.0 License
Get started using with the Gatsby Carbon theme which includes all configuration you might need to build a beautiful site inspired by the Carbon Design System.
Use the gatsby CLI to bootstrap your site with the starter
npx gatsby new my-carbon-site https://github.com/carbon-design-system/gatsby-starter-carbon-theme
Navigate into your directory and start it up
cd my-carbon-site/
gatsby develop
Navigate to localhost:8000
to see your site running
Each of the Items in your side bar correlates to a MDX file in your src/pages/
directory. Navigate to a site and try editing the corresponding markdown file. You'll be able to see it update live!
Lets check out the structure of our project
.
βββ LICENSE
βββ README.md
βββ gatsby-config.js
βββ node_modules
βββ package.json
βββ public
βββ src
β βββ gatsby-theme-carbon
β βββ pages
βββ yarn.lock
/node_modules
: This directory contains all of the modules of code that your project depends on (npm packages) are automatically installed.
/src
: This directory will contain all of the code related to what you will see on the front-end of your site.
gatsby-theme-carbon
components.gitignore
: This file tells git which files it should not track / not maintain a version history for.
gatsby-config.js
: This is the main configuration file for a Gatsby site. This is where you can specify information about your site (metadata) like the site title and description. You'll notice that all of the configuration for the site is coming from gatsby-theme-carbon
LICENSE
: Gatsby is licensed under the Apache 2.0 license.
yarn.lock
(See package.json
below, first). This is an automatically generated file based on the exact versions of your npm dependencies that were installed for your project. (You wonβt change this file directly).
package.json
: A manifest file for Node.js projects, which includes things like metadata (the projectβs name, author, etc). This manifest is how npm knows which packages to install for your project.
README.md
: This file!
This is where we'll document the various utility components as they're added.
Coming soon!
Coming soon!