mirrors/django-components
1
0
Fork 0
mirror of https://github.com/django-components/django-components.git synced 2025-11-25 16:39:11 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

refactor: use .nav.yml to define page order instead of nav weights (#1000)

Browse source
This commit is contained in:
Juro Oravec 2025-02-23 22:44:12 +01:00 • committed by GitHub
parent f36581ed86
commit d5e45125dc
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
57 changed files with 95 additions and 231 deletions
Download patch file Download diff file Expand all files Collapse all files

12
docs/overview/.nav.yml Normal file
View file

@ -0,0 +1,12 @@
# `.nav.yml` is provided by https://lukasgeiter.github.io/mkdocs-awesome-nav
nav:
- Welcome to Django Components: welcome.md
- Compatibility: compatibility.md
- Installation: installation.md
- Security notes 🚨: security_notes.md
- Community: community.md
- Contributing: contributing.md
- Development: development.md
- Performance: performance.md
- Code of Conduct: code_of_conduct.md
- License: license.md

5
docs/overview/code_of_conduct.md
View file

@ -1,6 +1 @@
---
title: Code of Conduct
weight: 9
---
--8<-- "CODE_OF_CONDUCT.md"

5
docs/overview/community.md
View file

@ -1,8 +1,3 @@
---
title: Community
weight: 5
---
## Community questions
The best place to ask questions is in our [Github Discussion board](https://github.com/django-components/django-components/discussions).

6
docs/overview/compatibility.md
View file

@ -1,9 +1,3 @@
---
title: Compatibility
weight: 2
---
## Compatibility
Django-components supports all supported combinations versions of [Django](https://docs.djangoproject.com/en/dev/faq/install/#what-python-version-can-i-use-with-django) and [Python](https://devguide.python.org/versions/#versions).
| Python version | Django version |

5
docs/overview/contributing.md
View file

@ -1,8 +1,3 @@
---
title: Contributing
weight: 6
---
### Bug reports
If you find a bug, please open an issue with detailed description of what happened.

5
docs/overview/development.md
View file

@ -1,8 +1,3 @@
---
title: Development
weight: 7
---
## Install locally and run the tests
Start by forking the project by clicking the **Fork button** up in the right corner in the [GitHub](https://github.com/django-components/django-components).

5
docs/overview/installation.md
View file

@ -1,8 +1,3 @@
---
title: Installation
weight: 3
---
1. Install `django_components` into your environment:
```bash

5
docs/overview/license.md
View file

@ -1,6 +1 @@
---
title: License
weight: 10
---
--8<-- "LICENSE"

5
docs/overview/performance.md
View file

@ -1,8 +1,3 @@
---
title: Performance
weight: 8
---
We track the performance of `django-components` using [ASV](https://asv.readthedocs.io/en/stable/).
See the [benchmarks dashboard](../../benchmarks).

5
docs/overview/security_notes.md
View file

@ -1,8 +1,3 @@
---
title: Security notes 🚨
weight: 4
---
_It is strongly recommended to read this section before using django-components in production._
## Static files

5
docs/overview/welcome.md
View file

@ -1,8 +1,3 @@
---
title: Welcome to Django Components
weight: 1
---
<img src="https://raw.githubusercontent.com/django-components/django-components/master/logo/logo-black-on-white.svg" alt="django-components" style="max-width: 100%; background: white; color: black;">
[![PyPI - Version](https://img.shields.io/pypi/v/django-components)](https://pypi.org/project/django-components/) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/django-components)](https://pypi.org/project/django-components/) [![PyPI - License](https://img.shields.io/pypi/l/django-components)](https://github.com/django-components/django-components/blob/master/LICENSE/) [![PyPI - Downloads](https://img.shields.io/pypi/dm/django-components)](https://pypistats.org/packages/django-components) [![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/django-components/django-components/tests.yml)](https://github.com/django-components/django-components/actions/workflows/tests.yml)