Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ahosgood committed Nov 28, 2023
1 parent 002e6ef commit e87332b
Showing 1 changed file with 7 additions and 12 deletions.
19 changes: 7 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,12 @@
# The National Archives Frontend Jinja2 Templates
# TNA Frontend Jinja

Jinja2 implementation of [TNA components](https://github.com/nationalarchives/tna-frontend) for inclusion in Python applications.
[![Main build status](https://img.shields.io/github/actions/workflow/status/nationalarchives/tna-frontend-jinja/ci.yml?style=flat-square&event=push&branch=main)](https://github.com/nationalarchives/tna-frontend-jinja/actions/workflows/ci.yml?query=branch%3Amain)
[![Latest release](https://img.shields.io/github/v/release/nationalarchives/tna-frontend-jinja?style=flat-square&logo=github&logoColor=white&sort=semver)](https://github.com/nationalarchives/tna-frontend-jinja/releases)
[![PyPi version](https://img.shields.io/pypi/v/nationalarchives-frontend-jinja?style=flat-square&logo=pypi&logoColor=white)](https://pypi.org/project/nationalarchives-frontend-jinja/)
![Python version](https://img.shields.io/pypi/pyversions/nationalarchives-frontend-jinja?style=flat-square&logo=python&logoColor=white)
[![Licence](https://img.shields.io/github/license/nationalarchives/tna-frontend-jinja?style=flat-square)](https://github.com/nationalarchives/tna-frontend-jinja/blob/main/LICENCE)

The rationale behind choosing Jinja was that it works with the two most popular Python frameworks:

- Django - [Django has support for the Jinja2 template engine](https://docs.djangoproject.com/en/4.2/topics/templates/#support-for-template-engines) which is then extended to [Wagtail support for Jinja](https://docs.wagtail.org/en/stable/reference/jinja2.html)
- Flask - [Jinja2 is the default template engine for Flask](https://flask.palletsprojects.com/en/2.3.x/templating/)

## Output

The Jinja2 templates and macros will be published to [PyPi](https://pypi.org/) which can then be included as a dependecy in Python projects.

For a full relationship diagram, see https://github.com/nationalarchives/tna-frontend#component-diagram.
## Quickstart

```sh
flask --app tna-frontend-jinja run --debug --port 5000
Expand Down

0 comments on commit e87332b

Please sign in to comment.