Welcome to Wagtail’s documentation¶
Wagtail is an open source CMS written in Python and built on the Django web framework.
Below are some useful links to help you get started with Wagtail.
If you’d like to get a quick feel for Wagtail, try spinning up a temporary developer environment in your browser (running on Gitpod - here’s how it works).
First steps
Using Wagtail
For editors
Index¶
- Getting started
- Usage guide
- Advanced topics
- Images
- Documents
- Icons
- Embedded content
- How to add Wagtail into an existing Django project
- Deploying Wagtail
- Performance
- Internationalisation
- Private pages
- Customising Wagtail
- Third-party tutorials
- Testing your Wagtail site
- Wagtail API
- How to build a site with AMP support
- Accessibility considerations
- Sustainability considerations
- About StreamField BoundBlocks and values
- Multi-site, multi-instance and multi-tenancy
- How to use a redirect with Form builder to prevent double submission
- StreamField migrations
- StreamField validation
- Managing the Reference Index
- Extending Wagtail
- Creating admin views
- Generic views
- Template components
- Using forms in admin views
- Adding reports
- Adding new Task types
- Audit log
- Customising the user account settings form
- Customising group edit/create views
- Custom image filters
- Extending client-side behaviour
- Rich text internals
- Extending the Draftail Editor
- Adding custom bulk actions
- Reference
- Support
- Using Wagtail: an Editor’s guide
- Contributing to Wagtail
- Release notes
- Upgrading Wagtail
- Wagtail 5.2.7 release notes
- Wagtail 5.2.6 release notes
- Wagtail 5.2.5 release notes
- Wagtail 5.2.4 release notes
- Wagtail 5.2.3 release notes
- Wagtail 5.2.2 release notes
- Wagtail 5.2.1 release notes
- Wagtail 5.2 (LTS) release notes
- Wagtail 5.1.3 release notes
- Wagtail 5.1.2 release notes
- Wagtail 5.1.1 release notes
- Wagtail 5.1 release notes
- Wagtail 5.0.5 release notes
- Wagtail 5.0.4 release notes
- Wagtail 5.0.3 release notes
- Wagtail 5.0.2 release notes
- Wagtail 5.0.1 release notes
- Wagtail 5.0 release notes
- Wagtail 4.2.4 release notes
- Wagtail 4.2.3 release notes
- Wagtail 4.2.2 release notes
- Wagtail 4.2.1 release notes
- Wagtail 4.2 release notes
- Wagtail 4.1.9 release notes
- Wagtail 4.1.8 release notes
- Wagtail 4.1.7 release notes
- Wagtail 4.1.6 release notes
- Wagtail 4.1.5 release notes
- Wagtail 4.1.4 release notes
- Wagtail 4.1.3 release notes
- Wagtail 4.1.2 release notes
- Wagtail 4.1.1 release notes
- Wagtail 4.1 (LTS) release notes
- Wagtail 4.0.4 release notes
- Wagtail 4.0.2 release notes
- Wagtail 4.0.1 release notes
- Wagtail 4.0 release notes
- Wagtail 3.0.3 release notes
- Wagtail 3.0.2 release notes
- Wagtail 3.0.1 release notes
- Wagtail 3.0 release notes
- Wagtail 2.16.3 release notes
- Wagtail 2.16.2 release notes
- Wagtail 2.16.1 release notes
- Wagtail 2.16 release notes
- Wagtail 2.15.6 release notes
- Wagtail 2.15.5 release notes
- Wagtail 2.15.4 release notes
- Wagtail 2.15.3 release notes
- Wagtail 2.15.2 release notes
- Wagtail 2.15.1 release notes
- Wagtail 2.15 (LTS) release notes
- Wagtail 2.14.2 release notes
- Wagtail 2.14.1 release notes
- Wagtail 2.14 release notes
- Wagtail 2.13.5 release notes
- Wagtail 2.13.4 release notes
- Wagtail 2.13.3 release notes
- Wagtail 2.13.2 release notes
- Wagtail 2.13.1 release notes
- Wagtail 2.13 release notes
- Wagtail 2.12.6 release notes
- Wagtail 2.12.5 release notes
- Wagtail 2.12.4 release notes
- Wagtail 2.12.3 release notes
- Wagtail 2.12.2 release notes
- Wagtail 2.12.1 release notes
- Wagtail 2.12 release notes
- Wagtail 2.11.9 release notes
- Wagtail 2.11.8 release notes
- Wagtail 2.11.7 release notes
- Wagtail 2.11.6 release notes
- Wagtail 2.11.5 release notes
- Wagtail 2.11.4 release notes
- Wagtail 2.11.3 release notes
- Wagtail 2.11.2 release notes
- Wagtail 2.11.1 release notes
- Wagtail 2.11 (LTS) release notes
- Wagtail 2.10.2 release notes
- Wagtail 2.10.1 release notes
- Wagtail 2.10 release notes
- Wagtail 2.9.3 release notes
- Wagtail 2.9.2 release notes
- Wagtail 2.9.1 release notes
- Wagtail 2.9 release notes
- Wagtail 2.8.2 release notes
- Wagtail 2.8.1 release notes
- Wagtail 2.8 release notes
- Wagtail 2.7.4 release notes
- Wagtail 2.7.3 release notes
- Wagtail 2.7.2 release notes
- Wagtail 2.7.1 release notes
- Wagtail 2.7 (LTS) release notes
- Wagtail 2.6.3 release notes
- Wagtail 2.6.2 release notes
- Wagtail 2.6.1 release notes
- Wagtail 2.6 release notes
- Wagtail 2.5.2 release notes
- Wagtail 2.5.1 release notes
- Wagtail 2.5 release notes
- Wagtail 2.4 release notes
- Wagtail 2.3 (LTS) release notes
- Wagtail 2.2.2 release notes
- Wagtail 2.2.1 release notes
- Wagtail 2.2 release notes
- Wagtail 2.1.3 release notes
- Wagtail 2.1.2 release notes
- Wagtail 2.1.1 release notes
- Wagtail 2.1 release notes
- Wagtail 2.0.2 release notes
- Wagtail 2.0.1 release notes
- Wagtail 2.0 release notes
- Wagtail 1.13.4 release notes
- Wagtail 1.13.3 release notes
- Wagtail 1.13.2 release notes
- Wagtail 1.13.1 release notes
- Wagtail 1.13 (LTS) release notes
- Wagtail 1.12.6 release notes
- Wagtail 1.12.5 release notes
- Wagtail 1.12.4 release notes
- Wagtail 1.12.3 release notes
- Wagtail 1.12.2 release notes
- Wagtail 1.12.1 release notes
- Wagtail 1.12 (LTS) release notes
- Wagtail 1.11.1 release notes
- Wagtail 1.11 release notes
- Wagtail 1.10.1 release notes
- Wagtail 1.10 release notes
- Wagtail 1.9.1 release notes
- Wagtail 1.9 release notes
- Wagtail 1.8.2 release notes
- Wagtail 1.8.1 release notes
- Wagtail 1.8 (LTS) release notes
- Wagtail 1.7 release notes
- Wagtail 1.6.3 release notes
- Wagtail 1.6.2 release notes
- Wagtail 1.6.1 release notes
- Wagtail 1.6 release notes
- Wagtail 1.5.3 release notes
- Wagtail 1.5.2 release notes
- Wagtail 1.5.1 release notes
- Wagtail 1.5 release notes
- Wagtail 1.4.6 release notes
- Wagtail 1.4.5 release notes
- Wagtail 1.4.4 release notes
- Wagtail 1.4.3 release notes
- Wagtail 1.4.2 release notes
- Wagtail 1.4.1 release notes
- Wagtail 1.4 (LTS) release notes
- Wagtail 1.3.1 release notes
- Wagtail 1.3 release notes
- Wagtail 1.2 release notes
- Wagtail 1.1 release notes
- Wagtail 1.0 release notes
- Wagtail 0.8.10 release notes
- Wagtail 0.8.8 release notes
- Wagtail 0.8.7 release notes
- Wagtail 0.8.6 release notes
- Wagtail 0.8.5 release notes
- Wagtail 0.8.4 release notes
- Wagtail 0.8.3 release notes
- Wagtail 0.8.1 release notes
- Wagtail 0.8 (LTS) release notes
- Wagtail 0.7 release notes
- Wagtail 0.6 release notes
- Wagtail 0.5 release notes
- Wagtail 0.4.1 release notes
- Wagtail 0.4 release notes