Skip to content

Commit 931fd1c

Browse files
committed
doc: #226 Add docs for custom logo and sidebar settings
1 parent 96264fa commit 931fd1c

1 file changed

Lines changed: 49 additions & 0 deletions

File tree

docs/source/installation.rst

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,55 @@ The default email address for outgoing course emails. If not specified, falls ba
132132
'FROM_EMAIL': 'courses@yourdomain.com',
133133
}
134134
135+
**SIDEBAR.CUSTOM_COMPONENT**
136+
137+
Optional configuration for injecting a custom component in the platform sidebar.
138+
139+
- ``SCRIPT_URL``: URL of the JavaScript module that registers your custom element.
140+
- ``STYLE_URL``: Optional stylesheet URL for the component (use ``None`` if not needed).
141+
- ``COMPONENT_TAG``: HTML tag rendered in the sidebar.
142+
143+
.. code-block:: python
144+
145+
DJANGO_EMAIL_LEARNING = {
146+
'SITE_BASE_URL': 'https://yourdomain.com',
147+
'ENCRYPTION_SECRET_KEY': 'your-very-long-random-string',
148+
'SIDEBAR': {
149+
'CUSTOM_COMPONENT': {
150+
'SCRIPT_URL': 'url/path-to-your-component.js',
151+
'STYLE_URL': 'url/path-to-your-component.css',
152+
'COMPONENT_TAG': '<your-component />',
153+
}
154+
},
155+
}
156+
157+
**LOGO**
158+
159+
Optional configuration for branding assets in the platform header.
160+
161+
- ``HORIZONTAL_LOCKUP``: Used on mobile devices where the sidebar is not open by default and the logo is shown in the top navbar.
162+
- ``VERTICAL_LOCKUP``: Used for sidebar-oriented layouts.
163+
164+
- ``LIGHT_BACKGROUND``: Logo URL/path for light backgrounds.
165+
- ``DARK_BACKGROUND``: Logo URL/path for dark backgrounds.
166+
167+
.. code-block:: python
168+
169+
DJANGO_EMAIL_LEARNING = {
170+
'SITE_BASE_URL': 'https://yourdomain.com',
171+
'ENCRYPTION_SECRET_KEY': 'your-very-long-random-string',
172+
'LOGO': {
173+
'HORIZONTAL_LOCKUP': {
174+
'LIGHT_BACKGROUND': 'url/path-to-horizontal-logo-for-light-background.png',
175+
'DARK_BACKGROUND': 'url/path-to-horizontal-logo-for-dark-background.png',
176+
},
177+
'VERTICAL_LOCKUP': {
178+
'LIGHT_BACKGROUND': 'url/path-to-vertical-logo-for-light-background.png',
179+
'DARK_BACKGROUND': 'url/path-to-vertical-logo-for-dark-background.png',
180+
},
181+
},
182+
}
183+
135184
Email Backend Configuration
136185
---------------------------
137186

0 commit comments

Comments
 (0)