Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README.rst #23

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.rst #23

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 16 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,22 @@ You can use the theme in two ways:
@import '@edx/elm-theme/paragon/overrides.scss';


-----------------------------------------
Including Elm Styles in a Paragon Project
-----------------------------------------

If you're using Paragon with Elm and are migrating from an old theme (default theme or edx-brand), please use this document:

https://openedx.atlassian.net/wiki/spaces/BPL/pages/3770744958/Migrating+MFEs+to+Paragon+design+tokens+and+CSS+variables#Requirements%3A

** Follow the above steps before trying to import the elm theme **



Notes:
1. This guide is for the alpha branch of Paragon, which is REQUIRED to use Elm until this project is complete https://github.com/openedx/platform-roadmap/issues/360
2. run npm install before trying to install elm theme as well.

-------------------------------------
Theming with Paragon's Design Tokens
-------------------------------------
Expand Down
Loading