Skip to main content

Simple CMS app for Django which supports i18n

Project description

Minicms
#######

**Minicms** is simple CMS app for Django which supports i18n in some extent and
markdown WYSIWYG editor inside admin.

Same page in different languages accessed via the same URL. If page doesn't
exist in requested locale default language is used, otherwise 404 returned

Requirements
============

- django >= 1.3
- markdown

Installation
============

**Minicms** should be installed using pip: ::

pip install minicms

Setup
=====

- 'Minicms' should be in your INSTALLED_APPS ::

INSTALLED_APPS += ('minicms',)

- Add 'minicms' urlpattern to base urls and specify view function ::

('^cms/', include('minicms.urls'))

- Run ``manage.py syncdb``

Usage
===========

**Minicms** uses 'minicms/default.html' template, passing current page in ``page``
context variable.

Page attributes you can use in template:

- ``lang`` - page language. Usually same as LANGUAGE_CODE context variable (see above)

- ``slug`` - page slug. All translations of the same page should have the same slug.
You can organize pages into some kind of hierarchy with slashes, eg:
installation
installation/requirements
installation/steps
installation/steps/1
installation/steps/2
installation/steps/3
pricing
pricing/free-plan

- ``name`` - localized page name. It will appear as a text under link in menu and
breadcrumbs

- ``title`` - title of a Page, intended for use in HTML title

- ``keywords`` - page keywords intended for use in HTML meta keywords (for SEO)

- ``description`` - same as keywords but description

- ``content`` - HTML content of the page

There are also ``minicms_breadcrumbs`` and ``minicms_menu`` template tags available
in ``minicms_tags`` tag library. You can override their appearance in templates
``minicms/tags/menu`` and ``minicms/tags/breadcrumbs``. See example templates_ for
details.

To put link on a certain page inside your templates,

{% url minicms page_slug %}

License
=======

Distrubuted under `GNU lesser general public license`_.

Copyright
=========

Copyright (c) 2012 Pavel Puchkin (neoascetic@gmail.com)

Markitup_: (c) 2008 Jay Salvat (http://markitup.jaysalvat.com/)

.. _Markitup: http://markitup.jaysalvat.com/
.. _GNU lesser general public license: http://www.gnu.org/copyleft/lesser.html
.. _templates: https://github.com/neoascetic/minicms/tree/master/minicms/templates
.. _neoascetic: https://github.com/neoascetic
.. _user2589: https://github.com/user2589

Project details


Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page