From d2cfc7190250153c0413c489144d1ebb37a220a1 Mon Sep 17 00:00:00 2001 From: "Elain T." Date: Fri, 11 Oct 2024 08:49:12 -0400 Subject: [PATCH] docs(design): move typography and theming docs to the guides folder (#3198) --- .../theming/README.md => guides/foundations/theming.md} | 6 +++--- .../README.md => guides/foundations/typography.md} | 0 libs/design/scss/README.md | 6 ------ 3 files changed, 3 insertions(+), 9 deletions(-) rename libs/design/{scss/theming/README.md => guides/foundations/theming.md} (97%) rename libs/design/{scss/typography/README.md => guides/foundations/typography.md} (100%) delete mode 100644 libs/design/scss/README.md diff --git a/libs/design/scss/theming/README.md b/libs/design/guides/foundations/theming.md similarity index 97% rename from libs/design/scss/theming/README.md rename to libs/design/guides/foundations/theming.md index 9514e6db17..7366f2cb14 100644 --- a/libs/design/scss/theming/README.md +++ b/libs/design/guides/foundations/theming.md @@ -1,8 +1,8 @@ -# Daffodil Theming +# Theming Daffodil's theming capabilities enables you to customize `@daffodil/design` components to reflect your brand. A theme consists of custom color configurations that will work in dark and light themes. ## Custom Colors -:stop: Before you begin, read the [accessibility guide on color in `@daffodil/design`](/libs/design/guides/color.md#accessibility). +:stop: Before you begin, read the [accessibility guide on color in `@daffodil/design`](./color.md#accessibility). ## Themes Dark and light modes are supported in all `@daffodil/design` components. When a theme is not specified, Daffodil defaults to the `light` mode. @@ -28,7 +28,7 @@ $daff-blue: ( ); ``` -### Define your own palettes +### Defining your own palettes You can define your own palettes by creating a Sass map that matches the example from above. Your Sass maps must have hues from 10 to 100, with a step increment of 10. ### Setting up your custom theme file diff --git a/libs/design/scss/typography/README.md b/libs/design/guides/foundations/typography.md similarity index 100% rename from libs/design/scss/typography/README.md rename to libs/design/guides/foundations/typography.md diff --git a/libs/design/scss/README.md b/libs/design/scss/README.md deleted file mode 100644 index bf58c873be..0000000000 --- a/libs/design/scss/README.md +++ /dev/null @@ -1,6 +0,0 @@ -# `@daffodil/design` SCSS Utilities - -`@daffodil/design` provides several utility files for rapid application development. - -- `utilities.scss` - A utility library containing things like breakpoints and sass language additions -- `theme.scss` - A utility library that allows you to theme `@daffodil/design` components