Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/theiliad/carbon-charts-design-docs
https://github.com/theiliad/carbon-charts-design-docs
Last synced: 6 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/theiliad/carbon-charts-design-docs
- Owner: theiliad
- License: apache-2.0
- Created: 2019-06-12T18:45:45.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-02-27T10:31:25.000Z (over 2 years ago)
- Last Synced: 2024-10-11T11:14:08.825Z (28 days ago)
- Language: JavaScript
- Size: 14.6 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Carbon Design Gatsby Starter
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](https://www.carbondesignsystem.com).
## 🧗 Getting started
1. **Create your site**
Use the gatsby CLI to bootstrap your site with the starter
```sh
npx gatsby new my-carbon-site https://github.com/carbon-design-system/gatsby-starter-carbon-theme
```
2. **Start developing**
Navigate into your directory and start it up
```sh
cd my-carbon-site/
gatsby develop
```
3. **Make some changes!**
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!
## 🔍 What's in here?
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
1. **`/node_modules`**: This directory contains all of the modules of code that your project depends on (npm packages) are automatically installed.
1. **`/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** this is where you'll override (known as shadowing) the default `gatsby-theme-carbon` components
- **pages** This is where most of your content will live. You'll represent each page with an MDX file.
1. **`.gitignore`**: This file tells git which files it should not track / not maintain a version history for.
1. **`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`
1. **`LICENSE`**: Gatsby is licensed under the Apache 2.0 license.
1. **`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).**
1. **`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.
1. **`README.md`**: This file!
## 👷 Components
This is where we'll document the various utility components as they're added.
## 📘 Resources
1. [Gatsby tutorial](https://www.gatsbyjs.org/tutorial/)
1. [MDX](https://mdxjs.com/)
## 👻 Configuration and Shadowing
Coming soon!
## 🚀 Deployment
Coming soon!