wagtail

.. image:: https://travis-ci.org/torchbox/wagtail.png?branch=master
:target: https://travis-ci.org/torchbox/wagtail

.. image:: https://coveralls.io/repos/torchbox/wagtail/badge.png?branch=master&zxcv1
:target: https://coveralls.io/r/torchbox/wagtail?branch=master

.. image:: https://pypip.in/v/wagtail/badge.png?zxcv
:target: https://crate.io/packages/wagtail/

Wagtail CMS
===========

.. image:: http://i.imgur.com/1OJwg4m.png

Wagtail is a Django content management system built originally for the `Royal College of Art `_ and focused on flexibility and user experience. Its features include:

* A fast, attractive editor interface
* Complete control over design with standard Django templates
* Configure content types through standard Django models
* Tightly integrated search (with an `Elasticsearch `_ backend for production)
* Strong document and image management
* Wide support for embedded content
* Simple, configurable permissions
* Support for tree-based content organisation
* Optional preview->submit->approve workflow
* Fast out of the box. `Varnish `_-friendly if you need it
* A simple `form builder `_
* Optional `static site generation `_
* Excellent `test coverage `_

Find out more at `wagtail.io `_.


Who's using it?
~~~~~~~~~~~~~~~
We've a list of public Wagtail sites here: https://github.com/torchbox/wagtail/wiki/Public-Wagtail-sites

Got one of your own? Feel free to add it!


Getting started
~~~~~~~~~~~~~~~
* To get you up and running quickly, we've provided a demonstration site with all the configuration in place, at `github.com/torchbox/wagtaildemo `_; see the `README `_ for installation instructions.
* See the `Getting Started `_ docs for installation (with the demo app) on a fresh Debian/Ubuntu box with production-ready dependencies, on OS X and on a Vagrant box.
* `Serafeim Papastefanos `_ has written a `tutorial `_ with all the steps to build a simple Wagtail site from scratch.
* We've also provided a skeletal django-template to get started on a blank site: https://github.com/torchbox/wagtail-template

Documentation
~~~~~~~~~~~~~
Available at `docs.wagtail.io `_ and always being updated.


Need Support?
~~~~~~~~~~~~~~~
Ask your questions on our `Wagtail support group `_.


Commercial Support
~~~~~~~~~~~~~~~~~~
Wagtail is sponsored by `Torchbox `_. If you need help implementing or hosting Wagtail, please contact us: hello@torchbox.com.


Compatibility
~~~~~~~~~~~~~
Wagtail supports Django 1.7.1+ on Python 2.7, 3.3 and 3.4.

Wagtail's dependencies are summarised at `requirements.io `_.


Contributing
~~~~~~~~~~~~
If you're a Python or Django developer, fork the repo and get stuck in!

We suggest you start by checking the `Ready to develop! `_ label and the `coding guidelines `_.

Send us a useful pull request and we'll post you a `t-shirt `_.

We also welcome translations for Wagtail's interface. Translation work should be submitted through `Transifex `_.

We run a separate Wagtail developers group here: https://groups.google.com/forum/#!forum/wagtail-developers please not that this is not for support requests.