Skip to content

Commit 0de12ce

Browse files
brian-smith-tcrilfeanil
authored andcommitted
docs: add more examples to brand README
1 parent 7d753b3 commit 0de12ce

1 file changed

Lines changed: 37 additions & 0 deletions

File tree

brand/README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,3 +73,40 @@ $ tree ~/.local/share/tutor-main/env/plugins/paragon
7373
```
7474
6. [Build](https://github.com/openedx/openedx-tutor-plugins/tree/main/plugins/tutor-contrib-paragon#build-all-themes) the theme
7575
7. Start `tutor` (`tutor dev start lms cms mfe` or `tutor local start lms cms mfe`)
76+
77+
### ***OR*** manually add to an MFE's `env.config.js(x)`
78+
Minimal `env.config.js` to install this theme
79+
80+
```js
81+
const config = {
82+
PARAGON_THEME_URLS: {
83+
variants: {
84+
light: {
85+
urls: {
86+
"default": "https://cdn.jsdelivr.net/npm/@openedx/paragon@$paragonVersion/dist/light.min.css",
87+
"brandOverride": "https://cdn.jsdelivr.net/gh/openedx/sample-plugin@main/brand/dist/light.min.css"
88+
},
89+
},
90+
},
91+
},
92+
};
93+
94+
export default config;
95+
```
96+
97+
### ***OR*** manually add to a `frontend-base` site's `site.config.tsx`
98+
Add the following block to your `SiteConfig` object in `site.config.tsx`
99+
100+
```tsx
101+
const siteConfig: SiteConfig = {
102+
[...]
103+
theme: {
104+
variants: {
105+
light: {
106+
url: 'https://cdn.jsdelivr.net/gh/openedx/sample-plugin@main/brand/dist/light.min.css
107+
},
108+
},
109+
},
110+
[...]
111+
}
112+
```

0 commit comments

Comments
 (0)