Wagtail is an open source content management system built on Django
 
 
 
 
 
Go to file
Matt Westcott ee837dedc5 in Page reference docs, don't tell people to consult source code (#3303)
Stylistically this sentence is somewhat content-free (if the API is really "relatively straightforward", users can see that for themselves rather than us informing them of that fact...), and we don't want to encourage people to use undocumented methods (because we can't guarantee that the API for them will remain stable).
2017-01-28 00:11:52 +00:00
.github Update pull request message to mention the need for linting and tests/docs 2016-11-09 10:35:14 +00:00
.tx Set up translations for modeladmin and table_block apps 2016-05-11 21:17:56 +01:00
client Move webpack configuration in subfolder of client/ 2017-01-26 01:16:04 +02:00
docs in Page reference docs, don't tell people to consult source code (#3303) 2017-01-28 00:11:52 +00:00
etc etc: add sample uwsgi and nginx configuration files 2015-05-01 15:02:29 +01:00
gulpfile.js Modeladmin scss cleanups (#2481) 2016-04-16 17:15:47 +01:00
scripts Set vm.max_map_count to 262144 2016-11-30 16:31:20 +00:00
wagtail Change to verbose view {draft,live} action labels on page listings (#3304) 2017-01-27 15:07:20 +00:00
.babelrc Tooling for modern front-end components: React JS, ES6, and BEM CSS 2016-02-25 13:32:48 +00:00
.coveragerc Update .coveragerc 2015-12-23 00:09:44 +01:00
.drone.yml rollback to Drone 0.4 2016-07-19 15:20:29 +01:00
.editorconfig Fix whitespace errors in docs 2016-11-28 13:41:35 +00:00
.eslintignore Tooling for modern front-end components: React JS, ES6, and BEM CSS 2016-02-25 13:32:48 +00:00
.eslintrc Tooling for modern front-end components: React JS, ES6, and BEM CSS 2016-02-25 13:32:48 +00:00
.gitignore gitignore clients nodemodules 2016-03-07 09:54:07 +00:00
.scss-lint.yml Remove SelectorFormat scss-lint rule that has so many arbitrary exclusions that there's no point in it existing 2016-11-03 16:58:53 +00:00
.travis.yml Install JDK8 on Travis for Elasticsearch 5 2016-11-30 16:31:20 +00:00
CHANGELOG.txt Changelog/release note for #3304 2017-01-27 15:10:07 +00:00
CODE_OF_CONDUCT.md Add Contributor Covenant 2016-02-03 15:47:50 +00:00
CONTRIBUTING.md Point people to Stack Overflow for support queries in preference to the Google group (#3255) 2017-01-03 16:02:24 +00:00
CONTRIBUTORS.rst Update model_reference.rst 2017-01-26 20:05:35 +00:00
LICENSE Add an initially empty django-wagtail package 2014-01-22 12:27:23 +00:00
MANIFEST.in Improvements to MANIFEST.IN 2016-03-09 14:30:25 +00:00
Makefile Run isort as part of 'make lint' 2016-06-23 16:31:44 +01:00
README.rst Point people to Stack Overflow for support queries in preference to the Google group (#3255) 2017-01-03 16:02:24 +00:00
conftest.py Implement support for using pytest (#2735) 2016-06-17 15:06:21 +01:00
npm-shrinkwrap.json freeze NPM packages at a point in time when they actually appear to collectively work 2016-05-04 16:24:37 +01:00
package.json Move webpack configuration in subfolder of client/ 2017-01-26 01:16:04 +02:00
runtests.py Added Elasticsearch 5 backend tests 2016-11-30 16:31:19 +00:00
setup.cfg Move flake8 config to setup.cfg 2016-06-23 16:31:44 +01:00
setup.py Update dependencies for django-modelcluster 3.0 2017-01-12 14:06:26 +00:00
tox.ini Install certifi when testing against Elasticsearch 5 2016-11-30 16:31:21 +00:00

README.rst

.. image:: https://api.travis-ci.org/wagtail/wagtail.svg?branch=master
    :target: https://travis-ci.org/wagtail/wagtail
.. 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
    :target: https://pypi.python.org/pypi/wagtail/
.. image:: https://coveralls.io/repos/torchbox/wagtail/badge.svg?branch=master
    :target: https://coveralls.io/r/torchbox/wagtail?branch=master

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

Wagtail is a content management system built on Django. It's focused on user experience,
and offers precise control for designers and developers.

.. image:: http://i.imgur.com/U5MDa0l.jpg
   :width: 728 px

Features
~~~~~~~~

* A fast, attractive interface for authors and editors
* Complete control over design with standard Django templates
* Configure content types through standard Django models
* Fast out of the box. Cache-friendly if you need it
* Tightly integrated search
* Strong document and image management
* Wide support for embedded content
* Straightforward integration with existing Django apps
* Simple, configurable permissions
* Workflow support
* An extensible `form builder <http://docs.wagtail.io/en/latest/reference/contrib/forms.html>`_
* Multi-site and multi-language support
* Optional `static site generation <http://docs.wagtail.io/en/latest/reference/contrib/staticsitegen.html>`_
* Excellent `test coverage <https://coveralls.io/r/torchbox/wagtail?branch=master>`_

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

Getting started
~~~~~~~~~~~~~~~

.. code-block:: sh

    pip install wagtail
    wagtail start mysite
    cd mysite
    python manage.py migrate
    python manage.py createsuperuser
    python manage.py runserver

then sign in at http://127.0.0.1:8000/admin/

For detailed installation and setup docs, see `docs.wagtail.io <http://docs.wagtail.io/>`_.

Who's using it?
~~~~~~~~~~~~~~~
`madewithwagtail.org <http://madewithwagtail.org>`_ lists some of the public Wagtail sites we know about; please `add your own <http://madewithwagtail.org/submit/>`_.

Documentation
~~~~~~~~~~~~~
`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.

Community Support
~~~~~~~~~~~~~~~~~
There is an active community of Wagtail users and developers responding to questions on `Stack Overflow <http://stackoverflow.com/questions/tagged/wagtail>`_. When posting questions, please read Stack Overflow's advice on `how to ask questions <http://stackoverflow.com/help/how-to-ask>`_ and remember to tag your question with "wagtail".

For topics and discussions that do not fit Stack Overflow's question-and-answer format, there is also a `Wagtail Support mailing list <https://groups.google.com/forum/#!forum/wagtail>`_.

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

Compatibility
~~~~~~~~~~~~~
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.

Contributing
~~~~~~~~~~~~
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).

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.

We also welcome translations for Wagtail's interface. Translation work should be submitted through `Transifex <https://www.transifex.com/projects/p/wagtail/>`_.