Frequently Asked Questions

What is the edx/edx-themes repo?

The edx-themes repo is a private repository that contains overrides of the Django/mako templates that live in the edx/edx-platform and edx/ecommerce repositories. These template overrides are used by the Comprehensive Theming feature to change the functionality of specific pages in LMS, Studio, and Otto for the Open EdX (the platform) sites that edX (the company) operates.

What is the edx/sample-themes repo?

The sample-themes repo is a public repository that is meant to be an example of how one might structure their template overrides for use with the Comprehensive Theming feature. It contains non-branded versions of template overrides that exist for the themes in the edx-themes repository.

How do I get started with edx/edx-themes?

1. Clone edx/edx-themes to the /edx/src directory on your devstack.

2. Modify the /etc/hosts file on your local machine adding host names for each site you would like to run. For example:

   127.0.0.1    customtheme.local

   This will allow you to access your devstack at http://customtheme.local:8000.

3. Set up Comprehensive Theming as described here and here: Comprehensive Theming.