Skip to content

Commit

Permalink
feat: Improved font and button sizes, fixes for Django 5 (#5)
Browse files Browse the repository at this point in the history
* Introduces nested css

* Fix: Action button icon size
Fix: wrong separator

* Compress

* Fix: Hover default buttons

* Fix link color in tables

* Update READEME

* Bump version

* Fix typo

* Fix readme
  • Loading branch information
fsbraun authored Jan 16, 2024
1 parent e46767e commit 121ebe4
Show file tree
Hide file tree
Showing 6 changed files with 274 additions and 214 deletions.
8 changes: 5 additions & 3 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,11 @@
Changelog
=========

unreleased
==========

Version 1.0.0
=============
* Refactor CSS using nesting
* Optimize text and icon sizes
* Improve compatibility for with Django 5 admin
* Fix select2 styling for 4 admin action buttons

Version 0.4.9
Expand Down
60 changes: 23 additions & 37 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,56 +1,42 @@
=============================
django CMS Simple Admin Style
=============================
=====================================
Django CMS Simple Admin Style
=====================================

|pypi| |django| |djangocms| |djangocms4|

This is a simple alternative for the `django CMS Admin Style <https://github.com/django-cms/djangocms-admin-style>`_. While django CMS admin style reorganizes Django's admin to offer a unified user experience, this package has a much simpler objective:
Overview
--------
The **Django CMS Simple Admin Style** is a lightweight alternative to the comprehensive `Django CMS Admin Style <https://github.com/django-cms/djangocms-admin-style>`_. Its goal is to refine the Django CMS interface with minimalistic changes:

* Adjust colors to be consistent with django CMS.
* Minimally adapt the css (e.g., add button borders) to keep the user interface consistent.
* Except this, avoid interfering with Django's admin styling: no `!important` statements, for example.
* Remove headers in django CMS' sidebar
* Remove headers, navigation and breadcrumbs in django CMS' modal
- Standardizing color schemes with Django CMS.
- Making minimal CSS adjustments like adding button borders for interface consistency.
- Restraining from interfering with Django's admin styling.
- Removing headers from Django CMS' sidebar and modal.

Also, no javascript is needed and all CSS is contained in a simple CSS file with less than 10kB in size.
All stylesheets are combined into a single CSS file under 10kB.

Documentation
=============

See ``requires`` in the `pyproject.toml <https://github.com/fsbraun/djangocms-simple-admin-style/blob/master/pyproject.toml>`_
file for additional dependencies.
Browser Support
---------------
The **Django CMS Simple Admin Style** uses CSS nesting to maintain a small stylesheet size, which makes it incompatible with Internet Explorer. It does work with all current versions of modern browsers. Visit `CanIUse <https://caniuse.com/css-nesting>`_ for more information on CSS features compatibility.

Installation
------------
For a manual installation:

For a manual install:

* run ``pip install djangocms-simple-admin-style``
* add ``djangocms_simple_admin_style`` to your ``INSTALLED_APPS`` just before ``'django.contrib.admin'``

- Run ``pip install djangocms-simple-admin-style``
- Add ``djangocms_simple_admin_style`` to your ``INSTALLED_APPS`` just before ``'django.contrib.admin'``

Configuration
Customization
-------------

The django CMS Admin Style overrides django admin's ``base_site.html``,
but you can still partially customize this page. Look at the source of
``templates/admin/base_site.html`` and override the templates that are included in various blocks. For example, you can add your own CSS in
``templates/admin/inc/extrastyle.html``.
While the Django CMS Simple Admin Style overrides Django admin's ``base_site.html``, you can still customize this page using the source of ``templates/admin/base_site.html`` and override the templates included in various blocks. For instance, you can insert your own CSS in ``templates/admin/inc/extrastyle.html``.

Contributing
------------
To contribute:

Contributions are highly welcome! Install the development environment by typing

.. code-block::
nvm use
npm install
Changes are made in the ``private/djangocms-simple-admin.css`` file.

Minify the file using ``. ./minify-css`` command.

- Set up the development environment with ``nvm use`` and ``npm install``.
- Changes should be made in ``private/djangocms-simple-admin.css``.
- Use ``. ./minify-css`` to minify the updated CSS file.

.. |pypi| image:: https://badge.fury.io/py/djangocms-simple-admin-style.svg
:target: http://badge.fury.io/py/djangocms-simple-admin-style
Expand Down
2 changes: 1 addition & 1 deletion djangocms_simple_admin_style/__init__.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = "0.4.9"
__version__ = "1.0.0"
Loading

0 comments on commit 121ebe4

Please sign in to comment.