Skip to main content

Wagtail Guide

CircleCI

What is it?

gif eg

Installation

Wagtailguide has a pypi package and can be installed with:

pip install wagtailguide

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:

INSTALLED_APPS = [
    ...
    'wagtail_guide',
    'wagtail.contrib.settings',
]

Usage

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

Metadata

Release files for wagtail-guide 1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for wagtail-guide 1
File Size Uploaded
wagtail_guide-1.tar.gz 7.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for wagtail-guide 1
File Interpreter ABI Platform
wagtail_guide-1-py3-none-any.whl Python 3 none any Details

Total release size: 18.3 kB

Release files / wagtail_guide-1.tar.gz

Download URL wagtail_guide-1.tar.gz
Size 7.0 kB
Tags Source
SHA-256 checksum
How to use checksums
1d4dc03ac37233b903cc17601620df38a616f9470f7316d5fcbeb54f03db495d
BLAKE2b-256 checksum
How to use checksums
05db29fc090e140bb7294ade012d69f0adfd12f8e9d92a170e4f6936fe6b62c7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.1

Release files / wagtail_guide-1-py3-none-any.whl

Download URL wagtail_guide-1-py3-none-any.whl
Size 11.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4b02b785bbc4883c6e8a9c2234fa598ef9fdd144ca1d1f5776c48c61f6e4f8ee
BLAKE2b-256 checksum
How to use checksums
b87937733d20ede75b7f897d4d82c11708191510002268f22ef421f161f856d0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.1

Release history Release notifications | RSS feed

2.2.0

2 release files

2.1.0

2 release files

2.0.2

2 release files

2.0.1

2 release files

2.0.0

2 release files

1.0.8

2 release files

1.0.7

1 release file

1.0.6

1 release file

1.0.5

1 release file

1.0.4

1 release file

1.0.3

2 release files

1.0.2

2 release files

1.0.1

2 release files

This release

1 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page