2016-12-15 11:49:49 +00:00
.. image :: https://api.travis-ci.org/wagtail/wagtail.svg?branch=master
:target: https://travis-ci.org/wagtail/wagtail
2015-05-14 11:15:16 +00:00
.. image :: https://img.shields.io/pypi/l/wagtail.svg
:target: https://pypi.python.org/pypi/wagtail/
.. image :: https://img.shields.io/pypi/v/wagtail.svg
2016-06-30 18:12:02 +00:00
:target: https://pypi.python.org/pypi/wagtail/
2015-05-14 11:15:16 +00:00
.. image :: https://coveralls.io/repos/torchbox/wagtail/badge.svg?branch=master
:target: https://coveralls.io/r/torchbox/wagtail?branch=master
2014-02-17 17:15:03 +00:00
2014-02-07 14:35:12 +00:00
Wagtail CMS
===========
2014-02-07 11:50:51 +00:00
2015-06-04 09:15:30 +00:00
Wagtail is a content management system built on Django. It's focused on user experience,
and offers precise control for designers and developers.
2015-05-14 11:31:55 +00:00
2015-05-14 11:15:16 +00:00
.. image :: http://i.imgur.com/U5MDa0l.jpg
2015-05-14 11:31:55 +00:00
:width: 728 px
2014-02-14 13:34:01 +00:00
2015-05-14 11:31:55 +00:00
Features
~~~~~~~~
2014-02-13 11:41:56 +00:00
2015-05-14 11:15:16 +00:00
* A fast, attractive interface for authors and editors
2014-02-13 11:41:56 +00:00
* Complete control over design with standard Django templates
* Configure content types through standard Django models
2015-05-14 11:15:16 +00:00
* Fast out of the box. Cache-friendly if you need it
* Tightly integrated search
2014-02-13 11:41:56 +00:00
* Strong document and image management
* Wide support for embedded content
2015-05-14 11:15:16 +00:00
* Straightforward integration with existing Django apps
2014-02-13 12:08:43 +00:00
* Simple, configurable permissions
2015-05-14 11:15:16 +00:00
* Workflow support
2015-07-09 18:47:46 +00:00
* An extensible `form builder <http://docs.wagtail.io/en/latest/reference/contrib/forms.html> `_
2015-05-14 11:15:16 +00:00
* Multi-site and multi-language support
2015-06-04 09:15:30 +00:00
* Optional `static site generation <http://docs.wagtail.io/en/latest/reference/contrib/staticsitegen.html> `_
2014-07-02 16:50:03 +00:00
* Excellent `test coverage <https://coveralls.io/r/torchbox/wagtail?branch=master> `_
2014-02-13 11:41:56 +00:00
2014-05-23 09:22:32 +00:00
Find out more at `wagtail.io <http://wagtail.io/> `_ .
2014-02-13 16:56:38 +00:00
2015-05-14 11:15:16 +00:00
Getting started
2014-09-16 14:45:22 +00:00
~~~~~~~~~~~~~~~
2016-01-06 12:51:53 +00:00
.. code-block :: sh
pip install wagtail
wagtail start mysite
cd mysite
python manage.py migrate
python manage.py createsuperuser
python manage.py runserver
2014-09-16 14:45:22 +00:00
2015-05-14 11:31:55 +00:00
then sign in at http://127.0.0.1:8000/admin/
2014-09-16 14:45:22 +00:00
2015-05-14 11:15:16 +00:00
For detailed installation and setup docs, see `docs.wagtail.io <http://docs.wagtail.io/> `_ .
Who's using it?
2014-02-12 18:21:16 +00:00
~~~~~~~~~~~~~~~
2015-05-14 11:15:16 +00:00
`madewithwagtail.org <http://madewithwagtail.org> `_ lists some of the public Wagtail sites we know about; please `add your own <http://madewithwagtail.org/submit/> `_ .
2014-02-12 18:21:16 +00:00
2014-05-23 09:22:32 +00:00
Documentation
~~~~~~~~~~~~~
2015-05-14 11:15:16 +00:00
`docs.wagtail.io <http://docs.wagtail.io/> `_ is the full reference for Wagtail, and includes guides for developers, designers and editors, alongside release notes and our roadmap.
2015-02-19 09:16:43 +00:00
2015-05-14 11:15:16 +00:00
Community Support
~~~~~~~~~~~~~~~~~
2015-03-24 09:41:06 +00:00
Ask your questions on our `Wagtail support group <https://groups.google.com/forum/#!forum/wagtail> `_ .
2015-02-19 09:16:43 +00:00
2015-04-02 11:36:29 +00:00
Commercial Support
~~~~~~~~~~~~~~~~~~
2015-04-02 11:53:44 +00:00
Wagtail is sponsored by `Torchbox <https://torchbox.com/> `_ . If you need help implementing or hosting Wagtail, please contact us: hello@torchbox.com.
2015-04-02 11:36:29 +00:00
2014-05-23 09:22:32 +00:00
Compatibility
~~~~~~~~~~~~~
2016-01-05 17:38:29 +00:00
Wagtail supports Django 1.8.1+ on Python 2.7, 3.3, 3.4 and 3.5. Supported database backends are PostgreSQL, MySQL and SQLite.
2015-02-19 09:16:43 +00:00
2014-02-12 18:21:16 +00:00
Contributing
~~~~~~~~~~~~
2015-05-14 11:15:16 +00:00
If you're a Python or Django developer, fork the repo and get stuck in! We run a separate group for developers of Wagtail itself at https://groups.google.com/forum/#!forum/wagtail-developers (please note that this is not for support requests).
2014-07-02 10:40:22 +00:00
2016-12-15 11:49:49 +00:00
You might like to start by reviewing the `contributing guidelines <http://docs.wagtail.io/en/latest/contributing/index.html> `_ and checking issues with the `difficulty:Easy <https://github.com/wagtail/wagtail/labels/difficulty%3AEasy> `_ label.
2014-07-02 10:40:22 +00:00
2015-04-22 09:36:00 +00:00
We also welcome translations for Wagtail's interface. Translation work should be submitted through `Transifex <https://www.transifex.com/projects/p/wagtail/> `_ .