Skip to content

Commit

Permalink
Merge pull request #21 from wagtail-packages/15-spelling-error-in-docs
Browse files Browse the repository at this point in the history
Fixes typo in README.md
  • Loading branch information
nickmoreton authored Feb 23, 2024
2 parents c7a4b61 + 34a18a9 commit 5f91aae
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 1 deletion.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ All notable changes to this project will be documented in this file.

## [Unreleased]

- Add loading the richtext filter in a template
- Fix typo in README.md
- update for wagtail 6.0, django 4.2 and python 3.9
- fix actions using mysql image

Expand Down
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Once the package is added to your Wagtail site, add one or two pieces of configu
Install the package into your python environment.

```bash
pip install wagtail-f-richext
pip install wagtail-f-richtext
```

Add the package to your INSTALLED_APS
Expand All @@ -34,6 +34,16 @@ Any css framework styles will need to be installed before you will see any style

## Using the f_richtext filter

The `f_richtext` filter can be used in your templates in the same way as the Wagtail core provided `richtext` filter.

First add the filter to your template.

```html
{% load wagtail_f_richtext %}
```

Then use it in your template.

### with a RichText field

- `{{ page.body|f_richtext:"framework" }}` will add classes to the HTML tags
Expand Down

0 comments on commit 5f91aae

Please sign in to comment.