django-markupmirror 0.1c1

Django field and widget for editing markup content (PlainText, HTML,Markdown, reStructuredText, Textile) using the CodeMirror editor withlive preview.

django-markupmirror is a custom field and widget for editing markup text in Django. It utilizes the CodeMirror JS editor for a richer editing experience.

It uses parts of James Turk's django-markupfield and adds a nicer widget with live-preview and an extension content-type for FeinCMS.

Documentation
on Read the Docs: http://django-markupmirror.readthedocs.org/
Code and issues
on bitbucket: https://bitbucket.org/fabianbuechler/django-markupmirror
Releases
on PyPi: http://pypi.python.org/pypi/django-markupmirror

Quickstart

  • To install django-markupmirror, use pip and add 'markupmirror' to the INSTALLED_APPS in your Django project.

  • In your settings.py specify at least MARKUPMIRROR_DEFAULT_MARKUP_TYPE which is 'plaintext' by default.

  • For the markup HTML-preview, you'll need to add markupmirror's URLs in your URLconf. In your urls.py add:

    import markupmirror.urls
    
    urlpatterns = patterns('',
        (r'^markupmirror/', include(markupmirror.urls.preview)),
    )
    
  • Add one or more markupmirror.fields.MarkupMirrorField s to your models and define markup_type or default_markup_type:

    class ModelWithMarkup(models.Model):
        content = MarkupMirrorField(
            verbose_name="content", markup_type='markdown')
    
  • If you want the FeinCMS content-type model MarkupMirrorContent, you'll also need to add 'markupmirror.feincms' to your INSTALLED_APPS.

    Also, you need to register the content-type model with FeinCMS' Page module:

    from feincms.module.page.models import Page
    from markupmirror.feincms.models import MarkupMirrorContent
    
    Page.create_content_type(MarkupMirrorContent)
    

By default, django-markupmirror comes with markup converters for plain text (converts links and linebreaks) and HTML (does nothing). Converters for Markdown, reStructuredText and Textile are also available, but require 3rd-party libraries to be installed. However, you can register your own markup converters.

Changelog

0.1c1 - 2012-08-25

  • A few documentation fixes. Thanks Paolo Dina.

0.1b2 - 2012-05-08

  • Fixed problem with initializing the editor in FeinCMS when adding new content blocks.

0.1b1 - 2012-05-08

  • Textarea to editor conversion and live preview now also works for standard models, in collapsed fieldsets, added inlines and when switching tabs in FeinCMS pages.

0.1a2 - 2012-05-03

  • Added jQuery plugin for CodeMirror initialization and preview updating. Thanks to Gustav Pursche!
  • Improved usage and installation docs.

0.1a1 - 2012-04-27

  • Initial release including MarkupMirrorField field, MarkupMirrorTextarea and AdminMarkupMirrorTextareaWidget widgets and providing FeinCMS integration with MarkupMirrorContent Page content-type. Supported markup types are plain text, HTML, Mardown, reStructuredText and Textile.
BSD License

Author

Fabian Büchler

Pip

django-markupmirror==0.1c1

Classifiers

  • Environment :: Web Environment
  • Framework :: Django
  • Intended Audience :: Developers
  • Operating System :: OS Independent
  • Programming Language :: Python
  • Development Status :: 4 - Beta
  • Natural Language :: English
  • License :: OSI Approved :: BSD License
  • Topic :: Software Development :: Libraries :: Python Modules
  • Topic :: Text Processing :: Markup
  • Programming Language :: JavaScript
File Type Python Version Uploaded On Downloads
django-markupmirror-0.2a1.tar.gz Source Sept. 24, 2014 1,105
django-markupmirror-0.1c1.tar.gz Source Aug. 25, 2012 2,933
Version Release Date
0.1c1 Aug. 25, 2012
0.1b2 May 8, 2012
0.1b1 May 8, 2012
0.1a2 May 3, 2012
0.1a1 April 17, 2012
Date Package Version Action
Aug. 26, 2015, 12:16 a.m. django-markupmirror 0.1a2 Release Created
Aug. 26, 2015, 12:16 a.m. django-markupmirror 0.1b2 Release Created
Aug. 26, 2015, 12:16 a.m. django-markupmirror 0.1b1 Release Created
Aug. 26, 2015, 12:16 a.m. django-markupmirror 0.1a1 Release Created
Aug. 26, 2015, 12:16 a.m. django-markupmirror 0.1c1 Release Created
Aug. 26, 2015, 12:16 a.m. django-markupmirror Package Created