Skip to main content

A Wagtail richdocument content type built with wagtail streamfield.

Project description

This is a wagtail app to be applied on wagtail generic docs. It adds the following streamfield blocks:

  • doc_byline
  • body_text
  • quote
  • bustout
  • code_chunk
  • math_formula
  • table
  • media_embed

Dependencies

Quick Start

install from pypy:

pip install wagtail-utphy-richdocument

add “utphy_richdocument” and “wagtail.contrib.table_block” to your INSTALLED_APPS setting:

INSTALLED_APPS = [
    ...
    'wagtail.contrib.table_block',
    'utphy_richdocument',
]
  • In your own app create a new model which subclasses the StreamFieldDoc model.

models.py:

from utphy_richdocument.models import StreamFieldDoc
from wagtail.wagtailadmin.edit_handlers import StreamFieldPanel

class YourModel(StreamFieldDoc):
    template = 'path_to_your_template.html'

    content_panels = Page.content_panels + [
        # your_model_fields
        StreamFieldPanel('body'),
]
  • In your template, make sure you have the following snippet:

path_to_your_template.py:

{% for block in self.body %}
  {{block}}
{% endfor %}

Finally run:

python manage.py collectstatic
python manage.py makemigrations
python manage.py migrate

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for wagtail-utphy-richdocument, version 0.7.5
Filename, size File type Python version Upload date Hashes
Filename, size wagtail-utphy-richdocument-0.7.5.tar.gz (23.6 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page