Skip to content

Commit 13750e7

Browse files
iamfoysaliamfoysal
committed
docs config
1 parent ac74b58 commit 13750e7

File tree

7 files changed

+175
-0
lines changed

7 files changed

+175
-0
lines changed

‎.github/workflows/genarate-docs.yml‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
name: Generate and Publish Documentation
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
pull_request:
8+
:
9+
- main
10+
11+
jobs:
12+
build:
13+
runs-on: ubuntu-latest
14+
15+
steps:
16+
- name: Checkout code
17+
uses: actions/checkout@v2
18+
19+
- name: Set up Python
20+
uses: actions/setup-python@v2
21+
with:
22+
python-version: '3.x'
23+
24+
- name: Install dependencies
25+
run: |
26+
python -m pip install --upgrade pip
27+
pip install mkdocs mkdocs-material
28+
29+
- name: Generate documentation
30+
run: |
31+
echo "import shutil" > generate_docs.py
32+
echo "def generate_docs():" >> generate_docs.py
33+
echo " with open('README.md', 'r') as readme_file:" >> generate_docs.py
34+
echo " readme_content = readme_file.read()" >> generate_docs.py
35+
echo " with open('docs/index.md', 'w') as index_file:" >> generate_docs.py
36+
echo " index_file.write(readme_content)" >> generate_docs.py
37+
echo "if __name__ == '__main__':" >> generate_docs.py
38+
echo " generate_docs()" >> generate_docs.py
39+
python generate_docs.py
40+
41+
- name: Deploy to GitHub Pages
42+
uses: peaceiris/actions-gh-pages@v3
43+
with:
44+
github_token: ${{ secrets.GITHUB_TOKEN }}
45+
publish_dir: ./docs

‎.gitignore‎

Whitespace-only changes.

‎README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
<br>
2727
</div>
2828

29+
## Resources
2930

3031
* [django-admin-sortable2](https://github.com/jrief/django-admin-sortable2) - Generic drag-and-drop ordering for objects in the Django admin interface [D 4.x]
3132
* [Django Jazzmin](https://github.com/farridav/django-jazzmin) - Drop-in theme for django admin, that utilises AdminLTE 3 & Bootstrap 4 to make yo' admin look jazzy [D >= 2]

‎docs/django.jpg‎

21.2 KB
Loading

‎docs/index.md‎

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
2+
<!-- badges -->
3+
![GitHub Contributors](https://img.shields.io/github/contributors/iamfoysal/Best-Django-Admin-interface) ![Visitors](https://api.visitorbadge.io/api/visitors?path=iamfoysal/Best-Django-Admin-interface&countColor=%23263759)
4+
<div align="center">
5+
6+
7+
8+
# Best-Django-Admin-interface [![Awesome](https://awesome.re/badge.svg)](https://awesome.re)
9+
> The Best-Django-Admin-Interface Resource.
10+
11+
<img src="django.jpg" align="django"/>
12+
13+
[![Repository](https://img.shields.io/badge/GitHub-URL-orange.svg)](https://github.com/iamfoysal/Best-Django-Admin-interface)[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/iamfoysal/Best-Django-Admin-interface/blob/main/LICENSE)
14+
15+
</div>
16+
17+
18+
<div align="center">
19+
<h1>Best Django Admin interface resources.</h1>
20+
</div>
21+
22+
<div align="center">
23+
Admin interface resources
24+
<br>
25+
<strong>Packages that extend the Admin interface, adding or improving features.</strong>
26+
<br>
27+
</div>
28+
29+
30+
* [django-admin-sortable2](https://github.com/jrief/django-admin-sortable2) - Generic drag-and-drop ordering for objects in the Django admin interface [D 4.x]
31+
* [Django Jazzmin](https://github.com/farridav/django-jazzmin) - Drop-in theme for django admin, that utilises AdminLTE 3 & Bootstrap 4 to make yo' admin look jazzy [D >= 2]
32+
* [django-admin-bootstrap](https://github.com/douglasmiranda/django-admin-bootstrap) - Responsive Skin for Django Admin. [D 1,11, 2.1, 2.2, 3.0]
33+
* [django-admin-bootstrapped](https://github.com/django-admin-bootstrapped/django-admin-bootstrapped/) - A Django admin theme using Twitter Bootstrap. [D 1.8]
34+
* [django-admin-easy](https://github.com/ebertti/django-admin-easy) - Collection of admin fields and decorators. [D 1.x, 2.x, 3.x, 4.x]
35+
* [django-admin-interface](https://github.com/fabiocaccamo/django-admin-interface) - The ultimate admin interface, based on a modern flat theme, it lets you customize the admin title, logo and colors by the admin itself. [D 3.x, 4.x]
36+
* [django-admin-tools](https://github.com/django-admin-tools/django-admin-tools) - A collection of extensions/tools for the default django administration interface. [D 1.1->4.0]
37+
* [django-admin2](https://github.com/jazzband/django-admin2/) - Extendable, adaptable rewrite of django.contrib.admin [D 2.2+]
38+
* [django-flat-theme](https://github.com/elky/django-flat-theme) - A flat theme for Django admin interface. Modern, fresh, simple. [included in D 1.9+!]
39+
* [django-flat-responsive](https://github.com/elky/django-flat-responsive) - An extension for Django admin and django-flat-theme that makes interface mobile friendly. [included in D 2.0+!]
40+
* [django-fluent-dashboard](https://github.com/django-fluent/django-fluent-dashboard) - An improved django-admin-tools dashboard for Django projects. [D 2.2+]
41+
* [django-grappelli](https://github.com/sehmaschine/django-grappelli/) - A jazzy skin for the Django Admin-Interface. [D 3.2, 4.0]
42+
* [django-hijack](https://github.com/arteria/django-hijack/) - Allows superusers to hijack (=login as) and work on behalf of another user. [no compatibility info, but recent updates]
43+
* [django-jet](https://github.com/geex-arts/django-jet) - Modern responsive template for the admin interface with improved functionality. [no versions listed, 5 yrs old]
44+
* [django-jet-reboot](https://github.com/b1go/django-jet-reboot) - Django Jet is modern template for Django admin interface with improved functionality. [D >= 3.0]
45+
* [django-material](https://github.com/viewflow/django-material) Material design for Django Forms and Admin. Template driven. [D 2.2-4.0]
46+
* [django-object-actions](https://github.com/crccheck/django-object-actions) A Django app for adding object tools for models in the admin. [D 2.1-4.2]
47+
* [django-suit](https://github.com/darklow/django-suit/) - Modern theme for Django admin interface. [no versions listed, 4.x?]
48+
* [django-wpadmin](https://github.com/barszczmm/django-wpadmin/) - WordPress look and feel for Django administration panel. [D 1.8]
49+
* [django-xadmin](https://github.com/sshwsfc/xadmin/) - Drop-in replacement of Django admin comes with lots of goodies, fully extensible with plugin support, pretty UI based on Twitter Bootstrap. [D >=1.9, 5 yrs old]
50+
* [yawd-admin](https://github.com/yawd/yawd-admin/) - An administration website for Django. [D 1.5, 9 yrs old]
51+
* [django-admin-env-notice](https://github.com/dizballanze/django-admin-env-notice) - Visually distinguish environments in Django Admin. [D 1.9+]
52+
* [simpleui](https://github.com/newpanjing/simpleui) - A modern theme based on vue+element-ui for django admin. [D 3.0]
53+
* [django-admin-vol](https://github.com/app-generator/django-admin-volt) - Modern Bootstrap5 Design [no versions listed, freemium]
54+
* [Django Semantic](https://github.com/globophobe/django-semantic-admin) - A completely free (MIT) Semantic UI admin theme for Django [no versions listed, but recent updates]
55+
* [djamin](https://github.com/hersonls/djamin/) - A new style for Django admin. [no versions listed, 9 yrs old]
56+
* [django-baton](https://github.com/otto-torino/django-baton) - A cool, modern and responsive django admin application based on bootstrap 5 [D >= 2.1]
57+
* [djangocms-admin-style](https://github.com/django-cms/djangocms-admin-style)- django CMS Admin Style is a Django Theme tailored to the needs of django CMS. [D 2.2+]
58+
* [django-admin-charts](https://github.com/PetrDlouhy/django-admin-charts)-Create beautiful configurable charts from your models and display them on the django-admin index page or on django-admin-tools dashboard. The charts are based on models and criterias defined through admin interface and some chart parameters are configurable in live view.
59+
* [django-adminlte2](https://github.com/adamcharnock/django-adminlte2)-A Django AdminLTE2 theme using adminlte3
60+
* [Black Dashboard Django](https://github.com/creativetimofficial/black-dashboard-django)-Black Dashboard - Open-source Django Template
61+
* [Django Unfold](https://github.com/unfoldadmin/django-unfold)- Modern Django admin theme for seamless interface development
62+
* [Django Daisy](https://github.com/hypy13/django-daisy)- Modern & Responsive & mobile friendly Django admin theme built with daisyui (tailwindcss)
63+
* [Django-mptt-admin](https://github.com/mbraak/django-mptt-admin)- Django-mptt-admin provides a nice Django Admin interface for Mptt models
64+
* [Django-mass-edit](https://github.com/burke-software/django-mass-edit)- Make bulk changes in the Django admin interface
65+
* [Django Semantic Admin](https://github.com/globophobe/django-semantic-admin)- ✨ Django Semantic UI admin theme
66+
67+
68+
69+
70+
71+
72+
73+
74+
75+
76+
77+
78+
79+
80+
81+
82+
83+
84+
85+
86+
87+
88+
89+
90+
91+
92+
93+
94+
95+
96+
97+
98+
99+
100+
101+
102+
103+
<hr>
104+
105+
## Contributors
106+
107+
108+
Thanks to these wonderful contributors:
109+
110+
![Contributors](https://contributors-img.web.app/image?repo=iamfoysal/Best-Django-Admin-interface)
111+

‎generate_docs.py‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
import shutil
2+
3+
def generate_docs():
4+
with open('README.md', 'r') as readme_file:
5+
readme_content = readme_file.read()
6+
7+
with open('docs/index.md', 'w') as index_file:
8+
index_file.write(readme_content)
9+
10+
if __name__ == "__main__":
11+
generate_docs()
12+
print("Documentation generated successfully.")

‎mkdocs.yml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
site_name: Best Django Admin Interface
2+
nav:
3+
- Home: index.md
4+
theme:
5+
name: material
6+

0 commit comments

Comments
 (0)