Skip to content

Commit

Permalink
docs: Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
fsbraun committed Jan 2, 2025
1 parent 5abf08d commit 793ae0b
Show file tree
Hide file tree
Showing 4 changed files with 52 additions and 60 deletions.
47 changes: 24 additions & 23 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@

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

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

.. image:: preview.png

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

- Support of other frameworks such as `Tailwind CSS <https://tailwindcss.com>`_
through custom components.

- **Separation of plugins from css framework**, i.e. no need to
rebuild you site's plugin tree if css framework is changed in the
future, e.g. from Bootstrap 5 to a future version.

- Leverage of new **djangocms-link features** allowing to link to internal pages
provided by other applications, such as `djangocms-blog
<https://github.com/nephila/djangocms-blog>`_.

- **Nice and well-arranged admin frontend** of djangocms-bootstrap4
- **Plugins are re-usable as UI components** anywhere in your project
(e.g. in a custom app) giving your whole project a more consistent
user experience.

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

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


Description
===========
django CMS Frontend is framework agnostic but comes with support of selected
components of Bootstrap 5. Components can have different templates for different
frameworks and the preferred framework can be set in the project settings.

It is up to you which (if any at all) components you want to include in your
project. Each set of components is a separate package you can include in your
project's ``INSTALLED_APPS``.

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

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

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

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

- django-cms, version 3.7 or later
- django-cms, version 3.11 or later
- django-filer, version 1.7 or later
- djangocms-attributes-field, version 1.0 or later
- djangocms-text
- django-entangled
- django-entangled 0.6 or later

Make sure `django Filer
<http://django-filer.readthedocs.io/en/latest/installation.html>`_ and
Expand Down
2 changes: 1 addition & 1 deletion docs/source/custom_components.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ Add a ``cms_components.py`` file to the ``theme`` app:
return self.title
@components.register
class MyButton(ComponentLinkMixin, CMSFrontendComponent):
class MyButton(CMSFrontendComponent):
class Meta:
name = "Button"
render_template = "components/button.html"
Expand Down
4 changes: 2 additions & 2 deletions docs/source/grid.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Below is an example of how you might do this::

<!-- Example of using the plugin template tag for a container -->
{% plugin "container" container_type="container-fluid" %}
{% plugin "row" %}
{% plugin "gridrow" %}
{% plugin "column" xs_col=6 %}
<p>This is the first column inside the container.</p>
{% endplugin %}
Expand Down Expand Up @@ -152,7 +152,7 @@ skipped they fall back to their defaults):
{% load frontend %}
{% plugin "gridcontainer" container_type="container-fluid" %}
{% plugin "row" vertical_alignment="align-items-center" %}
{% plugin "gridrow" vertical_alignment="align-items-center" %}
{% plugin "gridcolumn" xs_col=12 md_col=6 text_alignment="center" %}
This content is inside a column.
{% endplugin %}
Expand Down
59 changes: 25 additions & 34 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,15 @@
djangocms-frontend
********************

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

.. image:: preview.png

.. image:: ../../preview.png

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

- Support of other frameworks such as `Tailwind CSS <https://tailwindcss.com>`_
through custom components.

- **Separation of plugins from css framework**, i.e. no need to
rebuild you site's plugin tree if css framework is changed in the
future, e.g. from Bootstrap 5 to a future version.

- Leverage of new **djangocms-link features** allowing to link to internal pages
provided by other applications, such as `djangocms-blog
<https://github.com/nephila/djangocms-blog>`_.

- **Nice and well-arranged admin frontend** of djangocms-bootstrap4
- **Plugins are re-usable as UI components** anywhere in your project
(e.g. in a custom app) giving your whole project a more consistent
user experience.

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

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

*************
Description
*************

The plugins are framework agnostic and the framework can be changed by
adapting your project's settings. Also, it is designed to avoid having
to rebuild your CMS plugin tree when upgrading e.g. from one version of
your frontend framework to the next.
django CMS Frontend is framework agnostic but comes with support of selected
components of Bootstrap 5. Components can have different templates for different
frameworks and the preferred framework can be set in the project settings.

It is up to you which (if any at all) components you want to include in your
project. Each set of components is a separate package you can include in your
project's ``INSTALLED_APPS``.

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

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

**djangocms-frontend** provides a set of plugins to structure your
layout. This includes three basic elements

The grid
The grid is the basis for responsive page design. It splits the page
into containers, rows and columns. Depending on the device, columns
are shown next to each other (larger screens) or one below the other
(smaller screens).

Components
Components structure information on your site by giving them an easy
to grasp and easy to use look. Alerts or cards are examples of
components.


Contents
========

Expand Down

0 comments on commit 793ae0b

Please sign in to comment.