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
  • Getting started
  • Your first Wagtail site
  • Demo site
• Using Wagtail
  • Page models
  • Writing templates
  • How to use images in templates
  • Search
  • Third-party tutorials
• For editors
  • Editors guide

Index

• Getting started
  • Your first Wagtail site
  • Demo site
  • Integrating Wagtail into a Django project
  • The Zen of Wagtail
• Usage guide
  • Page models
  • Writing templates
  • How to use images in templates
  • Search
  • Snippets
  • How to use StreamField for mixed content
  • Permissions
• Advanced topics
  • Images
  • Documents
  • 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
  • About StreamField BoundBlocks and values
  • Multi-site, multi-instance and multi-tenancy
  • How to use a redirect with Form builder to prevent double submission
• Extending Wagtail
  • Creating admin views
  • Template components
  • Adding reports
  • Adding new Task types
  • Audit log
  • Customising the user account settings form
  • Customising group edit/create views
  • Rich text internals
  • Extending the Draftail Editor
  • Extending the Hallo Editor
  • Adding custom bulk actions
• Reference
  • Pages
  • StreamField reference
  • Contrib modules
  • Management commands
  • Hooks
  • Signals
  • Settings
  • The project template
  • Jinja2 template support
• Support
• Using Wagtail: an Editor’s guide
  • Introduction
  • Getting started
  • Finding your way around
  • Creating new pages
  • Editing existing pages
  • Copying and creating aliases to existing pages
  • Managing documents, images, snippets and collections
  • Managing Redirects
  • Administrator tasks
  • Browser issues
• Contributing to Wagtail
  • Issue tracking
  • Development
  • Committing code
  • UI Styleguide
  • General coding guidelines
  • Python coding guidelines
  • HTML coding guidelines
  • CSS coding guidelines
  • JavaScript coding guidelines
  • Documentation guidelines
  • Writing documentation
  • Reporting security issues
  • Wagtail’s release process