Skip to main content

A markdown field.

Project description

django-markdownfield PyPI

A simple custom field for Django that can safely render Markdown and store it in the database.

Your text is stored in a MarkdownField. When the model is saved, django-markdownfield will parse the Markdown, render it, sanitise it with bleach, and store the result in a RenderedMarkdownField for display to end users.

django-markdownfield also implements the EasyMDE editor in admin views to make working with Markdown easier.

alt test

Implementation

Implementing django-markdownfield is simple. See the below example.

from django.db import models

from markdownfield.models import MarkdownField, RenderedMarkdownField
from markdownfield.validators import VALIDATOR_STANDARD

class Page(models.Model):
    text = MarkdownField(rendered_field='text_rendered', validator=VALIDATOR_STANDARD)
    text_rendered = RenderedMarkdownField()

Please also set SITE_URL in your Django configuration - it will be needed for detecting external links.

SITE_URL = "https://example.com"

To disable the EasyMDE editor, see the amended line below.

text = MarkdownField(rendered_field='text_rendered', use_editor=False, use_admin_editor=True)

Use in templates

To use the rendered markdown in templates, just use the RenderedMarkdownField() you created on your model, like below. This field should be marked as safe with the safe filter to ensure it displays correctly.

{{ post.text_rendered | safe }}

Validators

django-markdownfield comes with a number of validators, which are used to process and clean the output of the markdown engine

VALIDATOR_STANDARD

from markdownfield.validators import VALIDATOR_STANDARD

This validator strips any tags that are not used by standard Markdown. It also automatically links any URLs in the output, adding class="external", rel="nofollow noopener noreferrer", and target="_blank" to any URLs which it determines to be external.

VALIDATOR_CLASSY

from markdownfield.validators import VALIDATOR_CLASSY

This validator does much the same as VALIDATOR_STANDARD, but it allows you to set the class on links and images. This is useful to create buttons and other enhanced links.

VALIDATOR_NULL

from markdownfield.validators import VALIDATOR_NULL

This validator does not call bleach to sanitize the output at all. This is not safe for user input. It allows arbitrary (unsafe) HTML in your markdown input.

Creating Custom Validators

To create a custom validator, just create an instance of the markdownfield.validators.Validator dataclass. An example of this is shown below.

from markdownfield.validators import Validator

# allows only bold and italic text
VALIDATOR_COMMENTS = Validator(
    allowed_tags=["b", "i", "strong", "em"],
    allowed_attrs={},
    linkify=False
)

You can also find a standard set of markdown-safe tags and attrs in markdownfield.validators, and extend that.

from markdownfield.validators import Validator, MARKDOWN_TAGS, MARKDOWN_ATTRS

# allows all standard markdown features,
# but also allows the class to be set on images and links
VALIDATOR_CLASSY = Validator(
    allowed_tags=MARKDOWN_TAGS,
    allowed_attrs={
        **MARKDOWN_ATTRS,
        'img': ['src', 'alt', 'title', 'class'],
        'a': ['href', 'alt', 'title', 'name', 'class']
    }
)

License

This software is released under the MIT license.

Copyright (c) 2019 Luke Rogers

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Project details


Download files

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

Source Distribution

django-markdownfield-0.5.1.tar.gz (772.6 kB view details)

Uploaded Source

Built Distribution

django_markdownfield-0.5.1-py3-none-any.whl (740.5 kB view details)

Uploaded Python 3

File details

Details for the file django-markdownfield-0.5.1.tar.gz.

File metadata

  • Download URL: django-markdownfield-0.5.1.tar.gz
  • Upload date:
  • Size: 772.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.22.0

File hashes

Hashes for django-markdownfield-0.5.1.tar.gz
Algorithm Hash digest
SHA256 4e96b63b16530033977687b82a35e12c4b64d02f3a9d8441f6950c6c43948cee
MD5 d84943ff3cb99772bb3ebb005e26549b
BLAKE2b-256 505ffeebd385684212220d1bd5fc2c445a39a4200324dc3fddf00df3cad7b984

See more details on using hashes here.

File details

Details for the file django_markdownfield-0.5.1-py3-none-any.whl.

File metadata

File hashes

Hashes for django_markdownfield-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5aa850276c0c81b0be12978102be7ffe12708cc019cab89e8d208a883f1e4fbb
MD5 e2aca3beec4f2f31e68e67e2683216a7
BLAKE2b-256 04ab0914d9a4a6af07d7d50f36488eda0d0f81c73aa77e64371b7ff73032f431

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page