Skip to content
Closed
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 10 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,12 @@
TEST

# Carbon Design System

![Deployment status](https://github.com/carbon-design-system/carbon-website/workflows/Deployment%20status/badge.svg)

This is the [Carbon Design System website](http://www.carbondesignsystem.com).
It's built using the
[gatsby-theme-carbon](https://gatsby.carbondesignsystem.com/) with
[GatsbyJS](https://www.gatsbyjs.org/).
This is the [Carbon Design System website](http://www.carbondesignsystem.com).
It's built using the [gatsby-theme-carbon](https://gatsby.carbondesignsystem.com/) with [GatsbyJS](https://www.gatsbyjs.org/).

## 📂 Structure

```
src
├── components
Comment on lines -9 to 11
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

removing the backtics cause this to not be formatted properly. I'd just leave them in.

├── data
Expand All @@ -20,31 +15,25 @@ src
├── pages
├── styles
├── util
```


## 👩‍💻 Develop

- 🤝 [Contribution guidelines](.github/CONTRIBUTING.md)
- 📚
[Content and Markdown guidelines](https://gatsby-theme-carbon.now.sh/components/markdown)
- 🗺
[Navigation guidelines](https://gatsby-theme-carbon.now.sh/guides/navigation/sidebar)
- 📚 [Content and Markdown guidelines](https://gatsby-theme-carbon.now.sh/components/markdown)
- 🗺 [Navigation guidelines](https://gatsby-theme-carbon.now.sh/guides/navigation/sidebar)

- `yarn install` – install dependencies
- `yarn install` – installs all project dependencies listed in `package.json`
- `yarn dev` – start the development server
- `yarn dev:clean` – use this if you have cache issues
- `lint:js` – lint your JavaScript files
- `format` - run Prettier
- `format` run Prettier

If you need more detailed information on how to set up your machine to develop
locally, please take a look at our
[wiki](https://github.com/carbon-design-system/carbon-website/wiki).
If you need more detailed information on how to set up your machine to develop locally, please take a look at our [wiki](https://github.com/carbon-design-system/carbon-website/wiki).

## 🚀 Build

Running the build command generates all the files and places them in the
`public` folder.
Running the build command generates all the files and places them in the `public` folder.

```
yarn build
```
Comment on lines -48 to -50
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why remove code formatting for this?


11 changes: 11 additions & 0 deletions gatsby-config.js
Original file line number Diff line number Diff line change
Expand Up @@ -73,5 +73,16 @@ module.exports = {
directory: path.resolve(__dirname, './src/data/chart-index'),
},
},
// Fix for Sass legacy JS API deprecation warnings:
{
resolve: 'gatsby-plugin-sass',
options: {
implementation: require('sass'), // Use Dart Sass explicitly
sassOptions: {
// No need for 'api' here as Dart Sass is default now, but you can silence warnings:
quietDeps: true,
},
},
},
],
};
5 changes: 4 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "carbondesignsystem",
"private": true,
"version": "2.0,0",
"version": "2.0.0",
"license": "MIT",
"workspaces": {
"packages": [
Expand All @@ -10,6 +10,7 @@
},
"scripts": {
"dev": "NODE_OPTIONS='--max-old-space-size=8192' gatsby develop -H 0.0.0.0",
"develop": "yarn dev",
"dev:clean": "gatsby clean && yarn dev",
"clean": "gatsby clean",
"build": "node --max-old-space-size=8192 ./node_modules/.bin/gatsby build",
Expand Down Expand Up @@ -46,6 +47,7 @@
"codesandbox": "^2.2.3",
"d3": "^7.9.0",
"gatsby": "^5.13.5",
"gatsby-plugin-sass": "^6.14.0",
"gatsby-plugin-sharp": "^5.13.1",
"gatsby-theme-carbon": "^4.3.6",
"markdown-it": "^14.1.0",
Expand All @@ -69,6 +71,7 @@
"markdown-loader": "^8.0.0",
"netlify-cli": "^18.1.0",
"prettier": "^2.0.2",
"sass": "^1.89.2",
"typescript": "^4.8.4"
},
"lint-staged": {
Expand Down
19 changes: 19 additions & 0 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -8752,6 +8752,7 @@ __metadata:
eslint-config-carbon: "npm:3.15.0"
gatsby: "npm:^5.13.5"
gatsby-plugin-lodash: "npm:^6.13.1"
gatsby-plugin-sass: "npm:^6.14.0"
gatsby-plugin-sharp: "npm:^5.13.1"
gatsby-plugin-sitemap: "npm:^6.13.1"
gatsby-source-filesystem: "npm:^5.13.1"
Expand All @@ -8768,6 +8769,7 @@ __metadata:
react: "npm:^18.2.0"
react-copy-to-clipboard: "npm:^5.1.0"
react-dom: "npm:^18.2.0"
sass: "npm:^1.89.2"
typescript: "npm:^4.8.4"
languageName: unknown
linkType: soft
Expand Down Expand Up @@ -24726,6 +24728,23 @@ __metadata:
languageName: node
linkType: hard

"sass@npm:^1.89.2":
version: 1.89.2
resolution: "sass@npm:1.89.2"
dependencies:
"@parcel/watcher": "npm:^2.4.1"
chokidar: "npm:^4.0.0"
immutable: "npm:^5.0.2"
source-map-js: "npm:>=0.6.2 <2.0.0"
dependenciesMeta:
"@parcel/watcher":
optional: true
bin:
sass: sass.js
checksum: 10c0/752ccc7581b0c6395f63918116c20924e99943a86d79e94f5c4a0d41b1e981fe1f0ecd1ee82fff21496f81dbc91f68fb35a498166562ec8ec53e7aad7c3dbd9d
languageName: node
linkType: hard

"sax@npm:>=0.6.0, sax@npm:^1.2.4":
version: 1.4.1
resolution: "sax@npm:1.4.1"
Expand Down
Loading