mirror of
https://github.com/django-components/django-components.git
synced 2025-10-03 18:54:33 +00:00
656 B
656 B
Adding examples
Rule of thumb:
If the example is a 3rd party package or it lives under a different URL, only link to it in overview.md
.
If the example is file(s) that we wrote:
- Define the component in
sampleproject/examples/components/<component_name>/<component_name>.py
. - Define a view / page component in
sampleproject/examples/pages/<component_name>/<component_name>.py
. - Add a new page here in the documentation named
<component_name>.md
, similarly to Tabs. - Link to that new page from
index.md
. - Update
.nav.yml
if needed. - Add a corresponding test file in
tests/test_example_<component_name>.py
.