-
Notifications
You must be signed in to change notification settings - Fork 249
Developers Guide ‐ Theme
In this guide we'll be looking at a type of plug-in for Adapt called theme. Themes change the look and feel of your Adapt course. They contain Less, templates, Javascript, fonts and assets.
The structure of an Adapt-compatible theme is as follows:
Folder | Purpose |
---|---|
assets | Holds any static assets (for example: images, etc.) |
fonts | Any fonts which might be referenced in the associated .less files |
js | JavaScript/JQuery files on which the theme depends go here |
less | Location for any Less based CSS files |
templates | Location for any snippets of pre-defined HTML templates (see below) |
Adapt themes support customisation for the rendering of various Adapt elements via the following Handlebars templates. Note that the template names are coordinated with the appropriate javascript file name:
- article.hbs
- block.hbs
- loading.hbs
- navigation.hbs
- page.hbs
Until this guide can be completed, please take a look at the technique explained in Modifying the Vanilla Theme.
If you already have a theme, and you would like to make it work with the Authoring Tool's editable themes feature, please see Making an existing theme editable.
TO DO: Add explanation of how to use "_classes"
by adding a CSS class to theme-extras.less or other Less file.
- Framework in Five Minutes
- Setting up Your Development Environment
- Manual Installation of the Adapt Framework
- Adapt Command Line Interface
- Common Issues
- Reporting Bugs
- Requesting Features
- Creating Your First Course
- Styling Your Course
- Configuring Your Project with config.json
- Content starts with course.json
- Course Localisation
- Compiling, testing and deploying your Adapt course
- Core Plugins in the Adapt Learning Framework
- Converting a Course from Framework Version 1 to Version 2
- Contributing to the Adapt Project
- Git Flow
- Adapt API
- Adapt Command Line Interface
- Core Events
- Core Model Attributes
- Core Modules
- Web Security Audit
- Peer Code Review
- Plugins
- Developing Plugins
- Developer's Guide: Components
- Developer's Guide: Theme
- Making a theme editable
- Developer's Guide: Menu
- Registering a Plugin
- Semantic Version Numbers
- Core Model Attributes
- Adapt Command Line Interface
- Accessibility v3
- Adapt Framework Right to Left (RTL) Support