Skip to main content

Adds functionality to add and edit a CMS guide page for editors.

Project description

Wagtail Guide

tests codecov

What is it?

The Wagtail Guide app adds functionality for creating and editing a guide for editors and publishers to help them create good content.


Wagtailguide has a pypi package and can be installed with:

pip install wagtail-guide

After installing, add it to your settings file along with wagtail.contrib.settings, the settings inclusion should be placed with your other wagtail.contrib libraries:



Wagtail Guide requires wagtail>=2.16


To edit the guide, the user needs to be an admin, or have the Manage editor guide 'change' value checked in their user group permissions.

Editing the guide

To edit the guide, from the left hand menu open settings > then click 'Manage editor guide'. Edit your content and then save.

guide edit

Guide navigation menu

If more than one 'heading' blocks are added to the content, an automatic menu will be displayed at the top of the guide under the heading 'Contents'

Viewing the guide

Once logged in, a new menu icon towards the bottom of the left hand menu will be visible labeled as 'Editor guide':

guide view

Project details

Download files

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

Source Distribution

wagtail_guide-1.0.8.tar.gz (10.1 kB view hashes)

Uploaded source

Built Distribution

wagtail_guide-1.0.8-py3-none-any.whl (13.9 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page