README.md

IBM Design Language website

This is the IBM Design Language website which is built using the gatsby-theme-carbon with GatsbyJS.

📂 Project structure

src
├── components
├── data
├── gatsby-theme-carbon
├── images
├── pages
├── styles
├── util

👩‍💻 Development

• 🤝 Contribution Guidelines

• 📚 Content/Markdown Guidelines

• 🗺 Navigation Guidelines

• yarn install – install dependencies

• yarn dev – start the development server

• yarn dev:clean – use this if you have cache issues

• lint:fix – lint your javascript files

• format - run prettier

If you need more detailed information on how to setup your machine to develop locally, please take a look at our wiki.

🚀 Build

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

yarn build

Adding and updating app icons

1. Create a new pull request that adds the light and dark versions to the src/images/app-icons folder.
2. In the same PR (or a new one) update the metadata yaml file

Note: yaml files are white-space and case sensitive. Be sure your category value matches an existing category exactly. You can copy and paste an existing icon to ensure you're formatting it properly.