README.rst
1##########
2django CMS
3##########
4.. image:: https://travis-ci.org/divio/django-cms.svg?branch=develop
5 :target: https://travis-ci.org/divio/django-cms
6.. image:: https://img.shields.io/pypi/v/django-cms.svg
7 :target: https://pypi.python.org/pypi/django-cms/
8.. image:: https://img.shields.io/badge/wheel-yes-green.svg
9 :target: https://pypi.python.org/pypi/django-cms/
10.. image:: https://img.shields.io/pypi/l/django-cms.svg
11 :target: https://pypi.python.org/pypi/django-cms/
12.. image:: https://codeclimate.com/github/divio/django-cms/badges/gpa.svg
13 :target: https://codeclimate.com/github/divio/django-cms
14 :alt: Code Climate
15
16Open source enterprise content management system based on the Django framework.
17
18.. image:: https://raw.githubusercontent.com/divio/django-cms/develop/docs/images/try-with-divio.png
19 :target: http://try.django-cms.org/
20 :alt: Try demo with Divio Cloud
21
22.. ATTENTION::
23
24 Please use the ``develop`` branch as the target for pull requests for on-going development.
25
26 Security fixes will be backported to older branches by the core team as appropriate.
27
28
29********
30Features
31********
32
33* hierarchical pages
34* extensive built-in support for multilingual websites
35* multi-site support
36* draft/publish workflows
37* version control
38* a sophisticated publishing architecture, that's also usable in your own applications
39* frontend content editing
40* a hierarchical content structure for nested plugins
41* an extensible navigation system that your own applications can hook into
42* SEO-friendly URLs
43* designed to integrate thoroughly into other applications
44
45Developing applications that integrate with and take advantage of django CMS features is easy and well-documented.
46
47More information on `our website <https://www.django-cms.org>`_.
48
49************
50Requirements
51************
52
53See the `Python/Django requirements for the current release version
54<http://docs.django-cms.org/en/latest/#software-version-requirements-and-release-notes>`_ in our documentation.
55
56See the `installation how-to guide for an overview of some other requirements and dependencies of the current release
57<http://docs.django-cms.org/en/latest/how_to/install.html>`_
58
59*************
60Documentation
61*************
62
63We maintain documentation for several versions of the project. Key versions are:
64
65* `stable <http://docs.django-cms.org>`_ (default), for the **current release** version
66* `latest <http://docs.django-cms.org/en/latest/>`_, representing the latest build of the **release-3.4.x branch**
67* `develop <http://docs.django-cms.org/en/develop/>`_, representing the latest build of the **develop branch**
68
69For more information about our branch policy, see `Branches
70<http://docs.django-cms.org/en/latest/contributing/development-policies.html>`_.
71
72Our documentation is hosted courtesy of `Read the Docs <https://readthedocs.org>`_.
73
74
75********
76Tutorial
77********
78
79http://docs.django-cms.org/en/latest/introduction/index.html
80
81***********
82Quick Start
83***********
84
85You can use the `django CMS installer <https://djangocms-installer.readthedocs.io>`_::
86
87 $ pip install --upgrade virtualenv
88 $ virtualenv env
89 $ source env/bin/activate
90 (env) $ pip install djangocms-installer
91 (env) $ mkdir myproject && cd myproject
92 (env) $ djangocms -f -p . my_demo
93 (env) $ python manage.py
94
95
96************
97Getting Help
98************
99
100Please head over to our IRC channel, #django-cms, on irc.freenode.net or write
101to our `mailing list <https://groups.google.com/forum/#!forum/django-cms>`_.
102
103If you don't have an IRC client, you can `join our IRC channel using the KiwiIRC web client
104<https://kiwiirc.com/client/irc.freenode.net/django-cms>`_, which works pretty well.
105
106******************
107Commercial support
108******************
109
110This project is backed by `Divio <https://www.divio.com/en/commercial-support/>`_.
111If you need help implementing or hosting django CMS, please contact us:
112sales@divio.com.
113
114*******
115Credits
116*******
117
118* Includes icons from `FamFamFam <http://www.famfamfam.com>`_.
119* Python tree engine powered by
120 `django-treebeard <https://tabo.pe/projects/django-treebeard/>`_.
121* JavaScript tree in admin uses `jsTree <https://www.jstree.com>`_.
122* Many thanks to
123 `all the contributors <https://github.com/divio/django-cms/graphs/contributors>`_
124 to django CMS!
125
