Changing the appearance of Open edX
Installing a custom theme
Comprehensive theming is enabled by default, but only the default theme is compiled. Indigo is a better, ready-to-run theme which you can start using today.
To compile your own theme, add it to the
git clone https://github.com/me/myopenedxtheme.git \ "$(tutor config printroot)/env/build/openedx/themes/myopenedxtheme"
themes folder should have the following structure:
openedx/themes/ mycustomtheme1/ cms/ ... lms/ ... mycustomtheme2/ ...
Then you must rebuild the openedx Docker image:
tutor images build openedx
Finally, you should enable your theme with the settheme command.
Developing a new theme
With Tutor, it’s pretty easy to develop your own themes. Start by placing your files inside the
env/build/openedx/themes directory. For instance, you could start from the
edx.org theme present inside the
cp -r /path/to/edx-platform/themes/edx.org "$(tutor config printroot)/env/build/openedx/themes/"
You should not create a soft link here. If you do, it will trigger a
Theme not found in any of the themes dirs error. This is because soft links are not properly resolved from inside docker containers.
Then, run a local webserver:
tutor dev runserver lms
tutor dev settheme mythemename
Re-build development docker image (and compile assets):
tutor images build openedx-dev
Watch the themes folders for changes (in a different terminal):
tutor dev run watchthemes
Make changes to some of the files inside the theme directory: the theme assets should be automatically recompiled and visible at http://local.overhang.io:8000.