Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs and add new entry in cookbook #730

Merged
merged 3 commits into from
Mar 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/cookbook/using_wysiwyg.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ class Post(Base):

- First create a `templates` directory in your project.
- Then add a file `custom_edit.html` there with the following content:
```html name="custom_edit.html"
```html title="custom_edit.html"
{% extends "edit.html" %}
{% block tail %}
<script src="https://cdn.ckeditor.com/ckeditor5/39.0.1/classic/ckeditor.js"></script>
Expand Down
4 changes: 2 additions & 2 deletions docs/working_with_templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,15 @@ SQLAdmin and in the `content` block it adds custom HTML tags:

!!! example

```html name="custom_details.html"
```html title="custom_details.html"
{% extends "details.html" %}
{% block content %}
{{ super() }}
<p>Custom HTML</p>
{% endblock %}
```

```python name="admin.py"
```python title="admin.py"
class UserAdmin(ModelView, model=User):
details_template = "custom_details.html"
```
Expand Down
39 changes: 20 additions & 19 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,34 +3,35 @@ site_description: Flexible admin dashboard for SQLAlchemy.
site_url: https://aminalaee.dev/sqladmin

theme:
name: 'material'
name: "material"
palette:
primary: white
primary: white
features:
- content.code.copy

repo_name: aminalaee/sqladmin
repo_url: https://github.com/aminalaee/sqladmin
edit_uri: ""

nav:
- Introduction: 'index.md'
- Configurations: 'configurations.md'
- Authentication: 'authentication.md'
- Working with Templates: 'working_with_templates.md'
- Working with Custom Views: 'writing_custom_views.md'
- Working with Files and Images: 'working_with_files.md'
- Introduction: "index.md"
- Configurations: "configurations.md"
- Authentication: "authentication.md"
- Working with Templates: "working_with_templates.md"
- Working with Custom Views: "writing_custom_views.md"
- Working with Files and Images: "working_with_files.md"
- Cookbook:
- Deployment with HTTPS: 'cookbook/deployment_with_https.md'
- Optimize relationship loading: 'cookbook/optimize_relationship_loading.md'
- Display custom attributes: 'cookbook/display_custom_attributes.md'
- Using a request object: 'cookbook/using_request_object.md'
- Multiple databases: 'cookbook/multiple_databases.md'
# - Structuring larger projects: 'cookbook/structuring_larger_projects.md'
# - Admin home page: 'cookbook/admin_home_page.md'
- Deployment with HTTPS: "cookbook/deployment_with_https.md"
- Optimize relationship loading: "cookbook/optimize_relationship_loading.md"
- Display custom attributes: "cookbook/display_custom_attributes.md"
- Using a request object: "cookbook/using_request_object.md"
- Multiple databases: "cookbook/multiple_databases.md"
- Using rich text editor: "cookbook/using_wysiwyg.md"
- API Reference:
- Application: 'api_reference/application.md'
- ModelView: 'api_reference/model_view.md'
- BaseView: 'api_reference/base_view.md'
- Authentication: 'api_reference/authentication.md'
- Application: "api_reference/application.md"
- ModelView: "api_reference/model_view.md"
- BaseView: "api_reference/base_view.md"
- Authentication: "api_reference/authentication.md"

markdown_extensions:
- markdown.extensions.codehilite:
Expand Down
Loading