Skip to content

Commit 5ffe79b

Browse files
committed
DOCS Update
1 parent f0e73a9 commit 5ffe79b

File tree

1 file changed

+55
-2
lines changed

1 file changed

+55
-2
lines changed

README.md

Lines changed: 55 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -107,14 +107,67 @@ Access the `admin` section in the browser: `http://127.0.0.1:8000/`
107107

108108
<br />
109109

110+
## How to Customize
111+
112+
When a template file is loaded, `Django` scans all template directories starting from the ones defined by the user, and returns the first match or an error in case the template is not found.
113+
The theme used to style this starter provides the following files:
114+
115+
```bash
116+
# This exists in ENV: LIB/admin_material
117+
< UI_LIBRARY_ROOT >
118+
|
119+
|-- templates/ # Root Templates Folder
120+
| |
121+
| |-- accounts/
122+
| | |-- login.html # Sign IN Page
123+
| | |-- register.html # Sign UP Page
124+
| |
125+
| |-- includes/
126+
| | |-- footer.html # Footer component
127+
| | |-- sidebar.html # Sidebar component
128+
| | |-- navigation.html # Navigation Bar
129+
| | |-- scripts.html # Scripts Component
130+
| |
131+
| |-- layouts/
132+
| | |-- base.html # Masterpage
133+
| | |-- base-auth.html # Masterpage for Auth Pages
134+
| |
135+
| |-- pages/
136+
| |-- index.html # Dashboard Page
137+
| |-- profile.html # Profile Page
138+
| |-- *.html # All other pages
139+
|
140+
|-- ************************************************************************
141+
```
142+
143+
When the project requires customization, we need to copy the original file that needs an update (from the virtual environment) and place it in the template folder using the same path.
144+
145+
For instance, if we want to customize the `footer.html` these are the steps:
146+
147+
- `Step 1`: create the `templates` DIRECTORY inside your app
148+
- `Step 2`: configure the project to use this new template directory
149+
- Edit `settings.py` TEMPLATES section
150+
- `Step 3`: copy the `footer.html` from the original location (inside your ENV) and save it to the `YOUR_APP/templates` DIR
151+
- Source PATH: `<YOUR_ENV>/LIB/admin_material/templates/includes/footer.html`
152+
- Destination PATH: `YOUR_APP/templates/includes/footer.html`
153+
- Edit the `footer.html` (Destination PATH)
154+
155+
At this point, the default version of the `footer.html` shipped in the library is ignored by Django.
156+
157+
In a similar way, all other files and components can be customized easily.
158+
159+
<br />
160+
110161
## [PRO Version](https://appseed.us/product/material-dashboard2-pro/django/)
111162

112-
This design is a pixel-perfect [Bootstrap 5](https://www.admin-dashboards.com/bootstrap-5-templates/) Dashboard with a fresh, new design inspired by Google's Material Design. `Material Dashboard 2 PRO` is built with over 300 frontend individual elements, like buttons, inputs, navbars, nav tabs, cards, or alerts, giving you the freedom of choosing and combining.
163+
This design is a pixel-perfect [Bootstrap 5](https://www.admin-dashboards.com/bootstrap-5-templates/) Dashboard with a fresh, new design inspired by Google's Material Design.
164+
`Material Dashboard 2 PRO` is built with over 300 frontend individual elements, like buttons, inputs, navbars, nav tabs, cards, or alerts, giving you the freedom of choosing and combining.
113165

114166
> Features:
115167
116168
- `Up-to-date Dependencies`
117-
- `Design`: [Django Theme Material2](https://github.com/app-generator/django-material-dashboard2-pro) - `PRO Version`
169+
- UI Theme: `Material2 PRO`
170+
- can be used in any Django project (new or legacy)
118171
- `Sections` covered by the design:
119172
- **Admin section** (reserved for superusers)
120173
- **Authentication**: `Django.contrib.AUTH`, Registration

0 commit comments

Comments
 (0)