Skip to content

Commit

Permalink
refactor: after review
Browse files Browse the repository at this point in the history
  • Loading branch information
PKulkoRaccoonGang committed May 22, 2024
1 parent 2a24bb4 commit 9e347cb
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 6 deletions.
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -316,8 +316,7 @@ If your component requires additional styling (which most likely is the case), e
component's directory `/src/MyComponent/index.scss` which by default contains an empty class for your component.

If you wish to use CSS variables (which is the preferred way of styling the components since values can be
easily overridden and customized by the consumers of Paragon), create specific design tokens in `tokens` directory (in the `core` and `themes` directories) and then generate (`npm run build-tokens`) CSS variables for your component.
This way the variables will also get automatically picked up by documentation site and displayed on your component's page.
easily overridden and customized by the consumers of Paragon), you can do so by utilizing [design tokens](/tokens).

**Please note that you need to follow [Paragon's CSS styling conventions](docs/decisions/0012-css-styling-conventions).**

Expand Down
3 changes: 1 addition & 2 deletions tokens/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# Design Tokens

This module is responsible for handling design tokens in Paragon, for rationale behind design tokens see [Scaling Paragon's styles architecture with design tokens](https://openedx.atlassian.net/wiki/spaces/BPL/pages/3630923811/Scaling+Paragon+s+styles+architecture+with+design+tokens)
and relevant ADR(TODO: add link when we merge an ADR).
This module is responsible for handling design tokens in Paragon, for rationale behind design tokens see [Scaling Paragon's styles architecture with design tokens](https://openedx.atlassian.net/wiki/spaces/BPL/pages/3630923811/Scaling+Paragon+s+styles+architecture+with+design+tokens).

## Overview

Expand Down
3 changes: 1 addition & 2 deletions www/src/pages/tools/component-generator.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,7 @@ If your component requires additional styling (which most likely is the case), e
component's directory `/src/MyComponent/index.scss` which by default contains an empty class for your component.

If you wish to use CSS variables (which is the preferred way of styling the components since values can be
easily overridden and customized by the consumers of Paragon), create specific design tokens in `tokens` directory (in the `core` and `themes` directories) and then generate (`npm run build-tokens`) CSS variables for your component.
This way the variables will also get automatically picked up by documentation site and displayed on your component's page.
easily overridden and customized by the consumers of Paragon), you can do so by utilizing [design tokens](/tokens).

**Please note that you need to follow [Paragon's CSS styling conventions](https://github.com/openedx/paragon/blob/master/docs/decisions/0012-css-styling-conventions).**

Expand Down

0 comments on commit 9e347cb

Please sign in to comment.