Skip to content

Latest commit

 

History

History
56 lines (34 loc) · 2.44 KB

README.rst

File metadata and controls

56 lines (34 loc) · 2.44 KB
Raw

Indigo, a cool blue theme for Open edX

Indigo is an elegant, customizable theme for Open edX.

Platform landing page

Installation

Indigo was specially developed to be used with Tutor (at least v3.11.1). If you have not installed Open edX with Tutor, then installation instructions will vary.

Clone the theme repository:

git clone https://github.com/overhangio/indigo

Render your theme:

tutor config render --extra-config ./indigo/config.yml ./indigo/theme "$(tutor config printroot)/env/build/openedx/themes/indigo"

Rebuild the Openedx docker image:

tutor images build openedx

Restart your platform:

tutor local start -d

You will then have to enable the "indigo" theme, as per the Tutor documentation:

tutor local settheme indigo localhost studio.localhost \
    $(tutor config printvalue LMS_HOST) $(tutor config printvalue CMS_HOST)

Customization

Setting custom values

A few settings in the theme can be easily customised: this includes the theme primary color, landing page tagline, footer legal links. Theme settings are defined in the config.yml file at the root of the repository. You can override all or part of those settings by creating you own config-custom.yml file. Then, render the theme with:

tutor config render \
    --extra-config ./indigo/config.yml \
    --extra-config ./indigo/config-custom.yml \
    ./indigo/theme "$(tutor config printroot)/env/build/openedx/themes/indigo"

Changing the default logo and other images

The theme images are stored in indigo/theme/lms/static/images for the LMS, and in indigo/theme/cms/static/images for the CMS. To use custom images in your theme, just replace the files stored in these folders with your own prior to running tutor config render.

License

This work is licensed under the terms of the GNU Affero General Public License (AGPL).