Wagtail is an open source content management system built on Django
 
 
 
 
 
Go to file
Tim Heap 254e675634 Use .. code-block:: console for all shell commands
This is the correct lexer for interactive console sessions, according to
<http://pygments.org/docs/lexers/>. This does require command lines to
be prefixed with `$`, otherwise they are interpreted as the output of a
command. It highlights the command nicely, including environment
variables, strings, and comments.
2016-11-28 13:41:35 +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
client
docs Use .. code-block:: console for all shell commands 2016-11-28 13:41:35 +00:00
etc
gulpfile.js
scripts
wagtail Add blocks as customisation hooks to wagtailadmin/login.html 2016-11-28 10:59:44 +11:00
.babelrc
.coveragerc
.drone.yml
.editorconfig
.eslintignore
.eslintrc
.gitignore
.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
CHANGELOG.txt Document new blocks in login template 2016-11-28 12:41:06 +00:00
CODE_OF_CONDUCT.md
CONTRIBUTING.md Fix links to contributing guidelines 2016-11-09 10:35:11 +00:00
CONTRIBUTORS.rst Fix errors by settings context processor in out-of-request templates 2016-11-24 12:14:58 +00:00
LICENSE
MANIFEST.in
Makefile
README.rst Fix links to contributing guidelines 2016-11-09 10:35:11 +00:00
conftest.py
npm-shrinkwrap.json
package.json
runtests.py Only show imminent DeprecationWarnings by default 2016-11-01 16:53:52 +00:00
setup.cfg
setup.py Update the Cloudflare backend to use the v4 API 2016-11-17 12:01:57 +00:00
tox.ini
webpack.base.config.js
webpack.dev.config.js
webpack.prd.config.js

README.rst

.. image:: https://api.travis-ci.org/torchbox/wagtail.svg?branch=master
    :target: https://travis-ci.org/torchbox/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
~~~~~~~~~~~~~~~~~
Ask your questions on our `Wagtail support group <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/torchbox/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/>`_.