Skip to main content

A Django text editor with Markdown and file upload support

Project description

Markdownme is a text editor component with Markdown syntax support, simplified file upload and deletion and a history of text changes. Its file-uploading history-containing nature makes it a better choice for more complex text entries which are edited by trusted users such as blog posts, as opposed to short text comments which anyone can post.

Detailed documentation is in the github project repository.

Quick start

  1. Add “markdownme” to your INSTALLED_APPS setting like this:

  2. Include the markdownme URLconf in your project like this:

    url(r'^markdownme/', include('markdownme.urls')),
  3. Run python migrate to create the markdownme models.

  4. Run python collectstatic to collect markdownme static files.

  5. Create your desired model and derive it from ‘MarkdownmeEntry’ like this:

    class Article(MarkdownmeEntry):
  6. Your model now has access to 3 new fields called:

  7. Include these in your Article admin fields like this:

    fields = ('title', 'date', 'markdown_text', 'markdown_identifier')
  8. Start the development server and visit to create an article (you’ll need the Admin app enabled).

  9. Your article text now has a fancy editor and you can also use ‘parsed_text’ to access the HTML resulting from your parsed Markdown text.

Project details

Release history Release notifications

This version
History Node


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
django-markdownme-0.1.tar.gz (28.3 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page