https://github.com/django-cms/djangocms-stories

django CMS stories application - Tell your story in multilingual posts, using the full power of django CMS placeholders.
https://github.com/django-cms/djangocms-stories

blogging django django-cms

Last synced: 3 months ago
JSON representation

django CMS stories application - Tell your story in multilingual posts, using the full power of django CMS placeholders.

• Host: GitHub
• URL: https://github.com/django-cms/djangocms-stories
• Owner: django-cms
• License: bsd-3-clause
• Created: 2025-06-19T11:05:17.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2026-04-28T19:59:10.000Z (3 months ago)
• Last Synced: 2026-04-28T21:08:05.585Z (3 months ago)
• Topics: blogging, django, django-cms
• Language: Python
• Homepage:
• Size: 647 KB
• Stars: 17
• Watchers: 0
• Forks: 7
• Open Issues: 12
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • Contributing: docs/contributing.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
=================

djangocms-stories

=================

|PyPiVersion| |TestCoverage| |PyVersion| |DjVersion| |CmsVersion|

**django CMS stories application - Tell your story in multilingual posts, using the full

power of django CMS placeholders.**

djangocms-stories provides a lean foundation for storytelling that can be composed with

other specialized django CMS applications, such as djangocms-versioning or djangocms-moderation.

********

Features

********

* Frontend editing using django CMS frontend editor

* Placeholder or optionally simpler TextField-based content editing

* Multilingual support using django-parler

* Multisite (posts can be visible in one or more Django sites on the same project)

* Hooks into your page tree anywhere

* Configurable permalinks, user navigation, template sets, ...

* Multiple instaces per site (e.g., blog, news, stories)

* Django sitemap framework

* django CMS Wizard integration

* Supports djangocms-versioning and djangocms-moderation

************

Installation

************

To install the latest version directly from GitHub, run:

.. code-block:: bash

    pip install djangocms-stories djangocms-text

Add ``djangocms_stories`` and ``djangocms_text`` to your ``INSTALLED_APPS`` in your Django project's ``settings.py``:

.. code-block:: python

    INSTALLED_APPS = [

        # ...

        'djangocms_text',  # required

        'djangocms_stories',

        'parler',  # if not already included

        'sortedm2m',  # if not already included

        # For now, but probably not needed in the future

        'taggit',

        'taggit_autosuggest',

        'meta',

        # ...

    ]

To use taggit's autosuggest feature, add their URLS in ``urls.py``:

.. code-block:: python

    urlpatterns += [path('taggit_autosuggest/', include('taggit_autosuggest.urls'))]

*****************************

Migrating from djangocms-blog

*****************************

Migrate from djangocms-blog by following the steps below. There is test coverage for the migration

process - nevertheless be sure to backup your database before proceeding.

1. Uninstall djangocsms-blog: ``pip uninstall djangocms-blog``

2. Install djangocms-stories ``pip install djangocms-stories``

3. Add ``"djangocms_stories"`` to your installed apps. Do **not** remove djangocms-blog.

4. Run ``./manage.py migrate djangocms_stories``. This in migration 0002 will move existing content

   from djangocms-blog to djangocms-stories and delete djangocms-blogs database tables.

5. Remove ``"djangocms_blog"`` from your installed apps.

6. To be on the safe side, check that the app hooks in the advanced settings your blog pages have been

   updated.

**Custom templates will need manual updating**, since the underlying model structure has changed:

* ``post`` contains the following fields: ``related``, ``main_image``, ``author``, ``date``, ``categories``, ``tags``

* ``post_content`` contiains the following per-language fields:

  ``title``, ``subtitle``, ``slug``, ``content``, ``media``, and ``post``, the reference

  to the ``Post`` object.

Some **improvements for developers** are included:

* You now can use the ``{% placeholder %}`` template tag in the post_detail.html template to render

  any placeholder. ``{% render_placeholder post_content.content %}`` and ``{% render_placeholder post_content.media %}``

  are still available, but you can now use ``{% placeholder "new_content" %}`` to, say, add additional placeholders.

************

Contributing

************

Because this is a an open-source project, we welcome everyone to

`get involved in the project `_ and

`receive a reward `_ for their contribution.

Become part of a fantastic community and help us make django CMS the best CMS in the world.

We'll be delighted to receive your

feedback in the form of issues and pull requests. Before submitting your

pull request, please review our `contribution guidelines

`_.

The project makes use of git pre-commit hooks to maintain code quality.

Please follow the installation steps to get `pre-commit `_

setup in your development environment.

We're grateful to all contributors who have helped create and maintain

this package. Contributors are listed at the `contributors

`_

section.

One of the easiest contributions you can make is helping to translate this addon on

`Transifex `_.

*******

Credits

*******

djangocms-stories is inspired by `Nephila's `_ excellent

`djangocms-blog `_, with the intent to bring

to align it with django CMS's new philosophy since version 4: "The design philosophy of

django CMS is to solve something complex with many simple things."

.. |PyPiVersion| image:: https://img.shields.io/pypi/v/djangocms-stories.svg?style=flat-square

    :target: https://pypi.python.org/pypi/djangocms-stories

    :alt: Latest PyPI version

.. |PyVersion| image:: https://img.shields.io/pypi/pyversions/djangocms-stories.svg?style=flat-square

    :target: https://pypi.python.org/pypi/djangocms-stories

    :alt: Python versions

.. |DjVersion| image:: https://img.shields.io/pypi/frameworkversions/django/djangocms-stories.svg?style=flat-square

    :target: https://pypi.python.org/pypi/djangocms-stories

    :alt: Django versions

.. |CmsVersion| image:: https://img.shields.io/pypi/frameworkversions/django-cms/djangocms-stories.svg?style=flat-square

    :target: https://pypi.python.org/pypi/djangocms-stories

    :alt: django CMS versions

.. |TestCoverage| image:: https://codecov.io/gh/django-cms/djangocms-stories/graph/badge.svg?token=O64yNt6pgo

    :target: https://codecov.io/gh/django-cms/djangocms-stories

    :alt: Test coverage

.. |License| image:: https://img.shields.io/github/license/django-cms/djangocms-stories.svg?style=flat-square

   :target: https://pypi.python.org/pypi/djangocms-stories/

    :alt: License