wagtail

mirror of https://github.com/wagtail/wagtail.git synced 2024-11-25 05:02:57 +01:00

A Django content management system focused on flexibility and user experience https://wagtail.org/

Go to file

Tom Dyson 3b691bc758 First pass at Sphinx docs		2014-02-18 17:45:31 +00:00
docs	First pass at Sphinx docs	2014-02-18 17:45:31 +00:00
wagtail	Merge pull request #62 from kaedroho/feature/docs-tests	2014-02-18 09:40:21 +00:00
.gitignore	First pass at Sphinx docs	2014-02-18 17:45:31 +00:00
.travis.yml	Omit vendor packages (treebeard currently) and migrations from code coverage.	2014-02-17 18:10:55 +00:00
CHANGELOG.txt	additions for setuptools	2014-02-07 15:39:59 +00:00
CONTRIBUTORS.rst	Update CONTRIBUTORS	2014-02-11 17:16:12 +00:00
LICENSE	Add an initially empty django-wagtail package	2014-01-22 12:27:23 +00:00
Makefile	add a general test runner for wagtail, accessible by running './runtests.py' or 'make test' from the wagtail repo, or 'manage.py test wagtail' from a django project such as wagtaildemo	2014-02-13 12:44:49 +00:00
MANIFEST.in	include new top-level text files in manifest	2014-02-07 15:57:54 +00:00
README.rst	Added PyPI version badge to README	2014-02-17 17:15:03 +00:00
requirements-dev.txt	typo	2014-02-07 15:56:49 +00:00
runtests.py	Add django.contrib.admin to test settings	2014-02-18 09:22:51 +00:00
setup.py	Removed requests dependency	2014-02-14 13:09:08 +00:00

README.rst

.. 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
    :target: https://coveralls.io/r/torchbox/wagtail?branch=master 

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

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

.. image:: http://i.imgur.com/4pbWQ35.png

Wagtail is a Django content management system built originally for the `Royal College of Art <http://www.rca.ac.uk/>`_ 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 <http://www.elasticsearch.org/>`_ 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 <https://www.varnish-cache.org/>`_-friendly if you need it
* Tests! But not enough; we're working hard to improve this

Find out more at `wagtail.io <http://wagtail.io/>`_.

Got a question? Ask it on our `Google Group <https://groups.google.com/forum/#!forum/wagtail>`_.

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 <https://github.com/torchbox/wagtaildemo/>`_; see the `README <https://github.com/torchbox/wagtaildemo/blob/master/README.md>`_ for installation instructions. `Serafeim Papastefanos <https://github.com/spapas>`_ has written a `tutorial <http://spapas.github.io/2014/02/13/wagtail-tutorial/>`_ with all the steps to build a simple Wagtail site from scratch.

Contributing
~~~~~~~~~~~~
If you're a Python or Django developer, fork the repo and get stuck in! Send us a useful pull request and we'll post you a `t-shirt <https://twitter.com/WagtailCMS/status/432166799464210432/photo/1>`_. Our immediate priorities are better docs, more tests, internationalisation and localisation.