Skip to content

Commit 793ae0b

Browse files
committed
docs: Update readme
1 parent 5abf08d commit 793ae0b

File tree

4 files changed

+52
-60
lines changed

4 files changed

+52
-60
lines changed

README.rst

Lines changed: 24 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@
44

55
|pypi| |docs| |coverage| |python| |django| |djangocms| |djangocms4|
66

7-
**django CMS Frontend** is a plugin bundle which originally built on and improved
8-
the architecture of `djangocms-bootstrap4 <https://github.com/django-cms/djangocms-bootstrap4>`_.
9-
Its objective is to provide a toolset to quickly create re-usable frontend
10-
components and comes preloaded with a set of popular frontend components
11-
independent of the currently used frontend framework such as Bootstrap, or
12-
its specific version.
7+
**django CMS Frontend** is a powerful plugin suite designed to streamline the
8+
integration of frontend frameworks into django CMS. Out of the box, it provides
9+
comprehensive support for Bootstrap 5, while also enabling the use of other
10+
CSS frameworks, such as Tailwind CSS, through custom components.
11+
Whether you're building responsive layouts or highly customized designs,
12+
django CMS Frontend is designed to simplify your development workflow.
1313

1414
.. image:: preview.png
1515

@@ -22,31 +22,35 @@ Key features
2222
- Support of `Bootstrap 5 <https://getbootstrap.com>`_, django CMS 3.8+
2323
and django CMS 4 out of the box.
2424

25+
- Support of other frameworks such as `Tailwind CSS <https://tailwindcss.com>`_
26+
through custom components.
27+
2528
- **Separation of plugins from css framework**, i.e. no need to
2629
rebuild you site's plugin tree if css framework is changed in the
2730
future, e.g. from Bootstrap 5 to a future version.
2831

29-
- Leverage of new **djangocms-link features** allowing to link to internal pages
30-
provided by other applications, such as `djangocms-blog
31-
<https://github.com/nephila/djangocms-blog>`_.
32-
33-
- **Nice and well-arranged admin frontend** of djangocms-bootstrap4
32+
- **Plugins are re-usable as UI components** anywhere in your project
33+
(e.g. in a custom app) giving your whole project a more consistent
34+
user experience.
3435

3536
- **Extensible** within the project and with separate project (e.g. a
3637
theme app). Create your own components with a few lines of code only.
3738

38-
- **Plugins are re-usable as UI components** anywhere in your project
39-
(e.g. in a custom app) giving your whole project a more consistent
40-
user experience.
4139

4240

4341
Description
4442
===========
43+
django CMS Frontend is framework agnostic but comes with support of selected
44+
components of Bootstrap 5. Components can have different templates for different
45+
frameworks and the preferred framework can be set in the project settings.
46+
47+
It is up to you which (if any at all) components you want to include in your
48+
project. Each set of components is a separate package you can include in your
49+
project's ``INSTALLED_APPS``.
4550

46-
The plugins are framework agnostic and the framework can be changed by
47-
adapting your project's settings. Also, it is designed to avoid having
48-
to rebuild your CMS plugin tree when upgrading e.g. from one version of
49-
your frontend framework to the next.
51+
The components are designed to be re-usable as UI components in your
52+
project, e.g. in a custom app, giving your whole project a more
53+
consistent user experience.
5054

5155
django CMS Frontend uses `django-entangled
5256
<https://github.com/jrief/django-entangled>`_ by Jacob Rief to avoid
@@ -55,9 +59,6 @@ Instead all design parameters are stored in a common JSON field and
5559
future releases of improved frontend features will not require to
5660
rebuild your full plugin tree.
5761

58-
The plugins are designed to be re-usable as UI components in your
59-
project, e.g. in a custom app, giving your whole project a more
60-
consistent user experience.
6162

6263
Contributing
6364
============
@@ -91,11 +92,11 @@ See ``REQUIREMENTS`` in the `setup.py
9192
<https://github.com/django-cms/djangocms-frontend/blob/master/setup.py>`_
9293
file for additional dependencies:
9394

94-
- django-cms, version 3.7 or later
95+
- django-cms, version 3.11 or later
9596
- django-filer, version 1.7 or later
9697
- djangocms-attributes-field, version 1.0 or later
9798
- djangocms-text
98-
- django-entangled
99+
- django-entangled 0.6 or later
99100

100101
Make sure `django Filer
101102
<http://django-filer.readthedocs.io/en/latest/installation.html>`_ and

docs/source/custom_components.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ Add a ``cms_components.py`` file to the ``theme`` app:
6565
return self.title
6666
6767
@components.register
68-
class MyButton(ComponentLinkMixin, CMSFrontendComponent):
68+
class MyButton(CMSFrontendComponent):
6969
class Meta:
7070
name = "Button"
7171
render_template = "components/button.html"

docs/source/grid.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Below is an example of how you might do this::
5454

5555
<!-- Example of using the plugin template tag for a container -->
5656
{% plugin "container" container_type="container-fluid" %}
57-
{% plugin "row" %}
57+
{% plugin "gridrow" %}
5858
{% plugin "column" xs_col=6 %}
5959
<p>This is the first column inside the container.</p>
6060
{% endplugin %}
@@ -152,7 +152,7 @@ skipped they fall back to their defaults):
152152
153153
{% load frontend %}
154154
{% plugin "gridcontainer" container_type="container-fluid" %}
155-
{% plugin "row" vertical_alignment="align-items-center" %}
155+
{% plugin "gridrow" vertical_alignment="align-items-center" %}
156156
{% plugin "gridcolumn" xs_col=12 md_col=6 text_alignment="center" %}
157157
This content is inside a column.
158158
{% endplugin %}

docs/source/index.rst

Lines changed: 25 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,15 @@
66
djangocms-frontend
77
********************
88

9-
**django CMS Frontend** is a plugin bundle which originally built on and improved
10-
the architecture of `djangocms-bootstrap4 <https://github.com/django-cms/djangocms-bootstrap4>`_.
11-
Its objective is to provide a toolset to quickly create re-usable frontend
12-
components and comes preloaded with a set of popular frontend components
13-
independent of the currently used frontend framework such as Bootstrap, or
14-
its specific version.
9+
**django CMS Frontend** is a powerful plugin suite designed to streamline the
10+
integration of frontend frameworks into django CMS. Out of the box, it provides
11+
comprehensive support for Bootstrap 5, while also enabling the use of other
12+
CSS frameworks, such as Tailwind CSS, through custom components.
13+
Whether you're building responsive layouts or highly customized designs,
14+
django CMS Frontend is designed to simplify your development workflow.
15+
16+
.. image:: preview.png
1517

16-
.. image:: ../../preview.png
1718

1819
**************
1920
Key features
@@ -25,31 +26,36 @@ its specific version.
2526
- Support of `Bootstrap 5 <https://getbootstrap.com>`_, django CMS 3.8+
2627
and django CMS 4 out of the box.
2728

29+
- Support of other frameworks such as `Tailwind CSS <https://tailwindcss.com>`_
30+
through custom components.
31+
2832
- **Separation of plugins from css framework**, i.e. no need to
2933
rebuild you site's plugin tree if css framework is changed in the
3034
future, e.g. from Bootstrap 5 to a future version.
3135

32-
- Leverage of new **djangocms-link features** allowing to link to internal pages
33-
provided by other applications, such as `djangocms-blog
34-
<https://github.com/nephila/djangocms-blog>`_.
35-
36-
- **Nice and well-arranged admin frontend** of djangocms-bootstrap4
36+
- **Plugins are re-usable as UI components** anywhere in your project
37+
(e.g. in a custom app) giving your whole project a more consistent
38+
user experience.
3739

3840
- **Extensible** within the project and with separate project (e.g. a
3941
theme app). Create your own components with a few lines of code only.
4042

41-
- **Plugins are re-usable as UI components** anywhere in your project
42-
(e.g. in a custom app) giving your whole project a more consistent
43-
user experience.
4443

4544
*************
4645
Description
4746
*************
4847

49-
The plugins are framework agnostic and the framework can be changed by
50-
adapting your project's settings. Also, it is designed to avoid having
51-
to rebuild your CMS plugin tree when upgrading e.g. from one version of
52-
your frontend framework to the next.
48+
django CMS Frontend is framework agnostic but comes with support of selected
49+
components of Bootstrap 5. Components can have different templates for different
50+
frameworks and the preferred framework can be set in the project settings.
51+
52+
It is up to you which (if any at all) components you want to include in your
53+
project. Each set of components is a separate package you can include in your
54+
project's ``INSTALLED_APPS``.
55+
56+
The components are designed to be re-usable as UI components in your
57+
project, e.g. in a custom app, giving your whole project a more
58+
consistent user experience.
5359

5460
django CMS Frontend uses `django-entangled
5561
<https://github.com/jrief/django-entangled>`_ by Jacob Rief to avoid
@@ -58,21 +64,6 @@ Instead all design parameters are stored in a common JSON field and
5864
future releases of improved frontend features will not require to
5965
rebuild your full plugin tree.
6066

61-
**djangocms-frontend** provides a set of plugins to structure your
62-
layout. This includes three basic elements
63-
64-
The grid
65-
The grid is the basis for responsive page design. It splits the page
66-
into containers, rows and columns. Depending on the device, columns
67-
are shown next to each other (larger screens) or one below the other
68-
(smaller screens).
69-
70-
Components
71-
Components structure information on your site by giving them an easy
72-
to grasp and easy to use look. Alerts or cards are examples of
73-
components.
74-
75-
7667
Contents
7768
========
7869

0 commit comments

Comments
 (0)