Skip to content

Commit ba92b2d

Browse files
committed
docs: explain brand section of plugin.py
1 parent 53271b3 commit ba92b2d

1 file changed

Lines changed: 8 additions & 2 deletions

File tree

tutor-contrib-sample/tutorsample/plugin.py

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -107,9 +107,15 @@
107107
))
108108

109109
# ---------------------------------------------------------------------------
110-
# Brand
110+
# Brand: Override Paragon theme CSS with brand-sample
111111
# ---------------------------------------------------------------------------
112-
# TODO: This assumes brand-sample has been pushed to jsdeliver.
112+
# Open edX MFEs load their Paragon design-system CSS at runtime via the
113+
# PARAGON_THEME_URLS setting. The "default" URL points at upstream Paragon;
114+
# the optional "brandOverride" URL is loaded on top to recolor/restyle the
115+
# theme. We point brandOverride at the compiled CSS in this repo's
116+
# brand-sample/ directory, served via jsDelivr straight from GitHub.
117+
#
118+
# TODO: This assumes brand-sample has been pushed to jsdelivr.
113119
# Is it possible to set this up for dev so that it loads the brand from
114120
# the filesystem instead?
115121
# ANSWER: Yes, it is possible using the tutor-contrib-paragon plugin.

0 commit comments

Comments
 (0)