Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
wuyue92tree committed Jul 9, 2019
1 parent c920dc3 commit 23d3484
Show file tree
Hide file tree
Showing 6 changed files with 92 additions and 2 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,22 @@ python manage.py migrate django_admin_settings
## general_option
![general_option](./images/general_option.jpg)

## menu list

![menu list](./images/menu-list.png)


# features

- [Custom General Option](https://django-adminlte-ui.readthedocs.io/en/latest/guide/#general-option)
- [Widgets](https://django-adminlte-ui.readthedocs.io/en/latest/guide/#widgets)
- [Custom Menu](https://django-adminlte-ui.readthedocs.io/en/latest/guide/#menu)

# TODO

- Custom Dashboard


# Thanks

- [AdminLTE](https://github.com/ColorlibHQ/AdminLTE)
Expand Down
12 changes: 12 additions & 0 deletions docs/about.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
# ChangeLog

## [v1.3.0](https://github.com/wuyue92tree/django-adminlte-ui/releases/tag/1.3.0b1)

- add exchange_menu logic with permission limit;
- add message when call exchange menu;
- update docs.

## [v1.3.0b1](https://github.com/wuyue92tree/django-adminlte-ui/releases/tag/1.3.0b1)

- update models, content_type option add null=True;
- add js logic for menu;
- add exchange_menu logic without permission limit.

## [v1.3.0b0](https://github.com/wuyue92tree/django-adminlte-ui/releases/tag/1.3.0b0)

- add treebeard as menu depends;
Expand Down
49 changes: 48 additions & 1 deletion docs/guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ before custom option, you should known what adminlte has used.
- site_header
- site_logo
- welcome_sign
- USE_CUSTOM_MENU

## Widgets

Expand Down Expand Up @@ -110,4 +111,50 @@ effect:

## Menu

developing ...
Custom your menu depends on database && treebeard.

`depth 2` only, more will not effective now.

### Menu Setting

Exchange Menu by click the `Exchange Menu` button

![menu list](https://github.com/wuyue92tree/django-adminlte-ui/blob/master/images/menu-list.png?raw=true)

### Menu Form

![menu form](https://github.com/wuyue92tree/django-adminlte-ui/blob/master/images/menu-form.png?raw=true)

- name: The menu name
- position: The position of your custom menu, default `left`
- link_type:
1. internal: django urls
2. external: third part urls
3. divide: link divide, like app verbose_name.
- link:
1. `admin:index`: django url name, recommend.
2. `/admin/`: django internal url, if you use i18n url, it's not a good choice.
3. `http://`: outside url
- icon: [icon](https://adminlte.io/themes/AdminLTE/pages/UI/icons.html)
- content_type: Use for permission control, if user don't have permission to access the `app_label:model` in content_type, it will be skipped.
- valid: This menu item effective only when the valid is True.
- treebeard option: for order.

### get django url name for link

```
╰─$ python manage.py shell
Python 3.6.6 (default, Sep 29 2018, 19:18:41)
Type 'copyright', 'credits' or 'license' for more information
IPython 7.5.0 -- An enhanced Interactive Python. Type '?' for help.
In [1]: from django.urls import resolve
In [2]: resolve('/zh-hans/admin/video/parsed/')
Out[2]: ResolverMatch(func=django.contrib.admin.options.changelist_view, args=(), kwargs={},
url_name=video_parsed_changelist, app_names=['admin'], namespaces=['admin'], route=zh-hans/admin/video/parsed/)
```

django url name = namespaces:url_name
17 changes: 16 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ INSTALLED_APPS = [
```
python manage.py migrate django_admin_settings
```
## screen shot
## Screen shot

### login page
![login](https://github.com/wuyue92tree/django-adminlte-ui/blob/master/images/login.jpg?raw=true)
Expand All @@ -64,6 +64,21 @@ python manage.py migrate django_admin_settings
### general_option
![general_option](https://github.com/wuyue92tree/django-adminlte-ui/blob/master/images/general_option.jpg?raw=true)

### menu list
![menu list](https://github.com/wuyue92tree/django-adminlte-ui/blob/master/images/menu-list.png?raw=true)


## Features

- [Custom General Option](https://django-adminlte-ui.readthedocs.io/en/latest/guide/#general-option)
- [Widgets](https://django-adminlte-ui.readthedocs.io/en/latest/guide/#widgets)
- [Custom Menu](https://django-adminlte-ui.readthedocs.io/en/latest/guide/#menu)

## Todo

- Custom Dashboard


## Thanks

- [AdminLTE](https://github.com/ColorlibHQ/AdminLTE)
Expand Down
Binary file added images/menu-form.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/menu-list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 23d3484

Please sign in to comment.