Package: tutor-indigo
Indigo is an elegant, customizable theme forOpen edX.You can view the theme in action athttps://sandbox.openedx.edly.io.InstallationIndigo was specially developed to be used withTutor(at least v14.0.0). If you have not installed Open edX with Tutor, then installation instructions will vary.Install and enable Indigo plugin:tutor plugins install indigo
tutor plugins enable indigo
tutor local launchThe Indigo theme will be automatically enabled if you have not previously defined a theme. To override an existing theme, use thesettheme command:tutor local do settheme indigoConfigurationINDIGO_WELCOME_MESSAGE(default: “The place for all your online learning”)INDIGO_PRIMARY_COLOR(default: “#3b85ff”)INDIGO_FOOTER_NAV_LINKS(default:[{"title":"About", "url":"/about"},{"title": "Contact", "url":"/contact"}])INDIGO_FOOTER_LEGAL_LINKS(default:[{"title":"Terms of service", "url":"/tos"},{"title": "Indigo theme for Open edX", "url":"https://github.com/overhangio/tutor-indigo"}])TheINDIGO_*settings listed above may be modified by runningtutor config save--setINDIGO_...=.... For instance, to remove all links from the footer, run:tutor config save --set "INDIGO_FOOTER_NAV_LINKS=[]" --set "INDIGO_FOOTER_LEGAL_LINKS=[]"Or, to set the primary color to forest green, run:# Note: The nested quotes are needed in order to handle the hash (#) correctly.
tutor config save --set 'INDIGO_PRIMARY_COLOR="#225522"'CustomizationThis plugin can serve as a starting point to create your own themes. Just fork this repository and modify the files as you see fit.You will have to start by installing indigo from source:git clone https://github.com/overhangio/tutor-indigo.git
pip install -e ./tutor-indigo
tutor plugins enable indigoAny change you make to the theme can be viewed immediately in development mode (withtutor dev …commands) after you run:tutor config saveTo deploy your changes to production, you will have to rebuild the “openedx” Docker image and restart your containers:tutor images build openedx
tutor local start -dChanging the Styling in Sass filesTo customize the theme stylesheets, modify the files in thetutorindigo/templates/indigo/lms/static/sass/andtutorindigo/templates/indigo/cms/static/sass/directories. In particular, the_extras.scssfiles should contain most styling rules.Changing the default logo and other imagesThe theme images are stored intutorindigo/templates/indigo/lms/static/imagesfor the LMS, and intutorindigo/templates/indigo/cms/static/imagesfor the CMS. To use custom images in your theme, just replace the files stored in these folders with your own.Overriding the default “about”, “contact”, etc. static pagesBy default, the/aboutand/contactpages contain a simple line of text: “This page left intentionally blank. Feel free to add your own content”. This is of course unusable in production. In the following, we detail how to override just any of the static templates used in Open edX.The static templates used by Open edX to render those pages are all stored in theedx-platform/lms/templates/static_templatesfolder. To override those templates, you should add your own in the following folder:ls tutorindigo/templates/indigo/lms/templates/static_templates"For instance, edit the “donate.html” file in this directory. We can derive the content of this file from the contents of thedonate.htmlstatic template in edx-platform:<%page expression_filter="h"/>
<%! from django.utils.translation import ugettext as _ %>
<%inherit file="../main.html" />

<%block name="pagetitle">${_("Donate")}</%block>

<main id="main" aria-label="Content" tabindex="-1">
    <section class="container about">
        <h1>
            <%block name="pageheader">${page_header or _("Donate")}</%block>
        </h1>
        <p>
            <%block name="pagecontent">Add a compelling message here, asking for donations.</%block>
        </p>
    </section>
</main>This new template will then be used to render the /donate url.TroubleshootingThis Tutor plugin is maintained by Hina Khadim fromEdly. Community support is available from the officialOpen edX forum. Do you need help with this plugin? See thetroubleshootingsection from the Tutor documentation.LicenseThis work is licensed under the terms of theGNU Affero General Public License (AGPL).