Skip to content

Commit

Permalink
Added introductory block to templates docs.
Browse files Browse the repository at this point in the history
Refs #6.
  • Loading branch information
carltongibson committed Apr 28, 2023
1 parent 45edb14 commit 5d5fc43
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions docs/source/templates.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,38 @@ Neapolitan's Templates
Neapolitan provides generic templates that can be used as a starting point for
your project.

The default templates use TailwindCSS classes, for styling. See the `guide here
for integrating TailwindCSS with Django <TwD>`_.

.. _TwD : https://noumenal.es/notes/tailwind/django-integration/

The templates ``{% extends "base.html" %}``, which must provide
``{% block content %}``. Neapolitan may provide a base template in the future,
see `issue #6 <https://github.com/carltongibson/neapolitan/issues/6>`_.

This is the full listing of the provided templates:

.. code-block:: shell
templates
└── neapolitan
├── object_confirm_delete.html
├── object_detail.html
├── object_form.html
├── object_list.html
└── partial
├── detail.html
└── list.html
You can override these templates by creating your own, either individually or as
a whole.

.. admonition:: Under construction 🚧

The templates are still being developed. If a change in a release affects
you, you can copy the templates from the previous version to continue, but
please also an open an issue to discuss.


``object_form.html``
=====================
Expand Down

0 comments on commit 5d5fc43

Please sign in to comment.