This is a pre-production deployment of Warehouse, however changes made here WILL affect the production instance of PyPI.
Latest Version Dependencies status unknown Test status unknown Test coverage unknown
Project Description
===============================
Django Flatpage Extensions
===============================

An extension to django.contrib.flatpages to provide

- Better support for **markdown** and other similar markup formats. We provide support for Markdown but you can write your own parser to support rst or creole.

- Optional support for the excellent **markItUp** jquery editor. This requires the installation ``django-markitup``.

- Easy inclusion of images in flatpages. Viewing Admin **image thumbnails** requires the installation of ``sorl-thumbnail``.

- The inclusion of HTML **metatags** such as keywords and descriptions in flatpages.

- Content **revisions**.

Migrating you data to flapages_x should not be difficult since the
data which currently in the contrib.Flatpage model (content, titles) is not affected.
Your templates will still utilize the *{{flatpage.content}}* and *{{flatpage.body}}*
context variables.
Once you install flatpages_x, the Markdown
is actually stored in the related Revisions model.
When you save a flatpage, this will be rendered as html via the markdown
parser and saved to the Flatpage.content field

Contributors
============
* `Christopher Clarke <https: github.com="" chrisdev="">`_
* `Lendl R Smith <https: github.com="" ilendl2="">`_
* `Mikhail Andreev <https: github.com="" adw0rd="">`_
* `Eddy <https: github.com="" nunchaks="">`_
Quickstart
===========
Create a virtual environment for your project and activate it::

$ virtualenv mysite-env
$ source mysite-env/bin/activate
(mysite-env)$

Next install ``flatpages_x`` ::

(mysite-env)$ pip install django-flatpages-x

Add ``flatpages_x`` to your INSTALLED_APPS setting.

Inside your project run::

(mysite-env)$ python manage.py syncdb

Django-flatpages-x comes with support for `Markdown <http: daringfireball.net="" projects="" markdown="" syntax=""/>`_
You can also associate and display images with your flatpages.
To include your images in your content using reference-style image syntax looks like this ::

![Atl text][image.pk]

Where [image.pk] is the primary key of image the that you want to include.
The primary key of the image
should is visible in the flatpages Admin form which will now contains an inline image form

markItUp support
------------------
If you want to use the excellent markItUp! editor widget. Install django-markItUp::

(mysite-env)$ pip install django-markitup

You need a few configuration steps

1. Add 'markitup' to your INSTALLED_APPS setting.

2. Add the following to settings::

MARKITUP_SET = 'markitup/sets/markdown'
MARKITUP_SKIN = 'markitup/skins/markitup'
MARKITUP_FILTER = ('markdown.markdown', {'safe_mode': True})

3. You need to use the AJAX-based preview for the admin widget::

url(r'^markitup/', include('markitup.urls'))

in your root URLconf.


Admin thumbnails
----------------
If you want view admin image thumbnails install sorl-thumbnail::

(mysite-env)$ pip install sorl-thumbnail

1. Add ``sorl.thumbnail`` to your ``settings.INSTALLED_APPS``.
2. Configure your ``settings``
3. If you are using the cached database key value store you need to sync the
database::

python manage.py syncdb

Markup Support
---------------
Django-flatpages-x come with a simple parser that supports Markdown. However,
you can supply your own parser by setting the value for *FLATPAGES_X_PARSER*
to settings.py. So if you want to use a parser ``myparser_parser`` simply add
the following to you settings ::

FLATPAGES_X_PARSER= ["flatpages_x.markdown_parser.parse", {}]

.. end-here

Documentation
--------------

See the `full documentation`_ for more details.

.. _full documentation: http://django-flatpages-x.readthedocs.org/
Release History

Release History

0.1.3

This version

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

0.1.2

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

0.1.1a

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

Download Files

Download Files

TODO: Brief introduction on what you do with files - including link to relevant help section.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
django-flatpages-x-0.1.3.tar.gz (13.9 kB) Copy SHA256 Checksum SHA256 Source Feb 2, 2017

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting