This package provides widgets and filters for mezzanine that enable admins
to use markdown formatting to create their site content, rather than using
-the tinymce editor to generate html.
-WMD is a rich text editor (*RTE*) that helps to produce markdown formatted text.
-This package provides widgets and filters to enable wmd and markdown for
-*rich content* types in mezzanine, such as *pages* and *blog posts*.
+the tinymce editor to generate html used in *rich content* types, such as
+*rich pages* and *blog posts*.
-templates, add to installed apps
+While not 100% neccessary, there are some styles in the default theme that
+will interfere with the rendering of the WmdWidget's preview panel when
+editing content on the site (rather than using the admin interface).
+In order to remedy this issue ensure the app directory template loader is
+activated and ``mdown`` is listed in ``INSTALLED_APPS`` **before** ``mezzanine.core``
+.. TODO: does the app order mean you don't have to remove the current theme's template?
+With the app installed, you need to make a couple choices.
This package provides 2 options for this setting.
-+ ``mdown.forms.WmdWidget`` *Activates the WMD rich text editor.*
-+ ``mdown.forms.PlainWidget`` *Use a plain Textarea (no rich text editor).*
++ ``"mdown.forms.WmdWidget"`` **(recommended)** *Activates the WMD rich text editor.*
++ ``"mdown.forms.PlainWidget"`` *Use a plain Textarea (no rich text editor).*
Again, there are 2 options for this setting.
-+ ``mdown.filters.plain`` *Renders the content using vanilla markdown formatting.*
-+ ``mdown.filters.codehilite`` *Renders the content using markdown with the
++ ``"mdown.filters.codehilite"`` *Renders the content using markdown with the
codehilite extension enabled.*
++ ``"mdown.filters.plain"`` *Renders the content using vanilla markdown formatting.*
Themes that were based on the default theme and were created prior to
-Mezzanine's 0.11.3 release will most likely not have the ``richtext_filter``
+Mezzanine's 0.11.3 release will most likely not have the ``richtext_filter``
applied to *rich content*. To correct this, you simply have to update the
templates for these content types so that the filter is used.