Skip to content

Commit df60667

Browse files
committed
Fix formatting
1 parent 1f6b30e commit df60667

File tree

2 files changed

+28
-122
lines changed

2 files changed

+28
-122
lines changed

docs/source/getting_started.rst

Lines changed: 0 additions & 119 deletions
This file was deleted.

docs/source/tutorial/components.rst

Lines changed: 28 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -104,10 +104,15 @@ Adding Styles and JavaScript
104104
``djangocms-frontend`` does not automatically include CSS or JavaScript files.
105105
You need to manually add them to your templates.
106106

107+
108+
.. index::
109+
single: base.html
110+
111+
107112
1. **Using Bootstrap 5 templates (recommended to get started quickly)**
108113

109114
The package is designed to work with Bootstrap 5 by default. If you want to use Bootstrap 5,
110-
extend the default template like this:
115+
extend the default template like this:
111116

112117
.. code-block:: django
113118
@@ -116,9 +121,28 @@ You need to manually add them to your templates.
116121
117122
This will load Bootstrap 5 CSS and JS from a CDN.
118123

124+
.. note::
125+
126+
We recommend developing your own ``base.html`` for your projects. The
127+
example templates load CSS and JS files from a CDN. Good reasons to do so
128+
are
129+
130+
* **djangocms-frontend** does not contain CSS or JS files from Bootstrap
131+
or any other framework for that matter. The example templates load
132+
CSS and JS from a CDN.
133+
* It is considered safer to host CSS and JS files yourself. Otherwise you
134+
do not have control over the CSS and/or JS that is delivered.
135+
* It is a common practice to customize at least the CSS part, e.g. with
136+
brand colors.
137+
* You might have a totally different build process for your styling assets,
138+
especially if you use other frameworks, such as Tailwind CSS.
139+
140+
141+
119142
2. **Custom Templates**
120143

121-
If you prefer to manage assets locally, download Bootstrap 5 and include it in your template:
144+
If you prefer to manage assets locally, download Bootstrap 5, customize as needed,
145+
and include it in your template:
122146

123147
.. code-block:: html
124148

@@ -135,7 +159,8 @@ You need to manually add them to your templates.
135159
Customizing Templates
136160
=====================
137161

138-
``djangocms-frontend`` allows for extensive customization through Django template blocks. Some key blocks you can override:
162+
``djangocms-frontend``'s built-in templates allow for extensive customization through
163+
Django template blocks. Some key blocks you can override:
139164

140165
The example template is customisable by a set of template blocks:
141166

0 commit comments

Comments
 (0)