From 6d49e09973158186844da634bd9eb3c3a55b1039 Mon Sep 17 00:00:00 2001 From: alimpens Date: Wed, 24 Jul 2024 12:53:00 +0200 Subject: [PATCH 1/3] Revert install pkgs to single line, multiline didn't copy well --- .../src/docs/developer-guide/getting-started.docs.mdx | 9 +-------- 1 file changed, 1 insertion(+), 8 deletions(-) diff --git a/storybook/src/docs/developer-guide/getting-started.docs.mdx b/storybook/src/docs/developer-guide/getting-started.docs.mdx index 15beb4f365..7395310710 100644 --- a/storybook/src/docs/developer-guide/getting-started.docs.mdx +++ b/storybook/src/docs/developer-guide/getting-started.docs.mdx @@ -10,14 +10,7 @@ import { Meta } from "@storybook/blocks"; Install the packages you need, for instance: -```bash - npm install - @amsterdam/design-system-assets - @amsterdam/design-system-css - @amsterdam/design-system-react - @amsterdam/design-system-react-icons - @amsterdam/design-system-tokens -``` +`npm install @amsterdam/design-system-assets @amsterdam/design-system-css @amsterdam/design-system-react @amsterdam/design-system-react-icons @amsterdam/design-system-tokens` Import the components and stylesheets you need, for example: From 6b7c374947906ee88d2633af21f4d563d5f23f34 Mon Sep 17 00:00:00 2001 From: alimpens Date: Wed, 24 Jul 2024 13:01:39 +0200 Subject: [PATCH 2/3] Link directly to template --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ce2111a485..12383c4a8b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -222,4 +222,4 @@ Contact the maintainers if you want to release a new version of a package. ## :pray: Credits -This document is adapted from a template made by [@jessesquires](https://github.com/jessesquires). +This document is adapted from [a template made by jessesquires](https://github.com/jessesquires/.github). From fb2e0f4c6f3bfd692ea2f99dc26fbdddd6d2aab7 Mon Sep 17 00:00:00 2001 From: alimpens Date: Wed, 24 Jul 2024 13:06:35 +0200 Subject: [PATCH 3/3] Link to CONTRIBUTING.md, fix install line --- .../src/docs/developer-guide/getting-started.docs.mdx | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/storybook/src/docs/developer-guide/getting-started.docs.mdx b/storybook/src/docs/developer-guide/getting-started.docs.mdx index 7395310710..d00f8cebb9 100644 --- a/storybook/src/docs/developer-guide/getting-started.docs.mdx +++ b/storybook/src/docs/developer-guide/getting-started.docs.mdx @@ -10,7 +10,9 @@ import { Meta } from "@storybook/blocks"; Install the packages you need, for instance: -`npm install @amsterdam/design-system-assets @amsterdam/design-system-css @amsterdam/design-system-react @amsterdam/design-system-react-icons @amsterdam/design-system-tokens` +```bash +npm install @amsterdam/design-system-assets @amsterdam/design-system-css @amsterdam/design-system-react @amsterdam/design-system-react-icons @amsterdam/design-system-tokens +``` Import the components and stylesheets you need, for example: @@ -38,3 +40,7 @@ To use the compact mode, import the compact CSS **after** the theme CSS, like so import "@amsterdam/design-system-tokens/dist/index.css"; import "@amsterdam/design-system-tokens/dist/compact.css"; ``` + +## Contributing + +Do you want to contribute to this project? Please review [our Contributing guidelines](https://github.com/Amsterdam/design-system/blob/develop/CONTRIBUTING.md).