Skip to main content

Serve .md pages as Django templates.

Project description

Django Markdown View

Serve .md pages as Django templates.

Requirements

Tested with:

The Tested With section describes aspirational goals.

  • Python: 3.5, 3.6, 3.7, 3.8

  • Django: 2.2, 3.0

Installation

  1. Install with pip install django-markdown-view.

  2. Add 'markdown_view' to your INSTALLED_APPS setting.

    INSTALLED_APPS = [
        ...,
        'markdown_view',
        ...
    ]
  3. (OPTIONAL) Add BASE_DIR setting (dictionary of app base), for example:

    BASE_DIR = os.path.dirname(os.path.dirname(os.path.dirname(__file__)))

Usage

Views

Use one of MarkdownView, LoggedInMarkdownView, or StaffMarkdownView to serve a .md file

from markdown_view import StaffMarkdownView

path('readme/',
    StaffMarkdownView.as_view(file_name='my_app/README.md'),
    name="readme"),

Authors

Wharton Computing

  • Ryan J. Sullivan

Other

Changelog

0.0.2 (2020-07-06)

  1. Remove support for Django pre-2.2

  2. Adds missing file markdown_view/markdown_extensions.py

0.0.1 (2020-06-16)

  1. Initial release.

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-markdown-view-0.0.2.tar.gz (10.6 kB view details)

Uploaded Source

Built Distribution

django_markdown_view-0.0.2-py2.py3-none-any.whl (13.4 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file django-markdown-view-0.0.2.tar.gz.

File metadata

  • Download URL: django-markdown-view-0.0.2.tar.gz
  • Upload date:
  • Size: 10.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.24.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.8.3

File hashes

Hashes for django-markdown-view-0.0.2.tar.gz
Algorithm Hash digest
SHA256 74ae9d3b755ab815fa7e293f4260b321e38799e9832921114ce927b0521b5b09
MD5 daae56011d1d05062b756c8f558e3f86
BLAKE2b-256 09b17dcdc05d53c3bf111c41bbad40af83946fc44bbc9d80e3aaf49adf49f677

See more details on using hashes here.

File details

Details for the file django_markdown_view-0.0.2-py2.py3-none-any.whl.

File metadata

  • Download URL: django_markdown_view-0.0.2-py2.py3-none-any.whl
  • Upload date:
  • Size: 13.4 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.24.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.8.3

File hashes

Hashes for django_markdown_view-0.0.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 7f905d3302ddf8a0c057ee0e1ab01b811e5b8d3bbd4354706ce2ded388045f34
MD5 311d8ed4acaf4eb06907f9b84af9c7d3
BLAKE2b-256 e54be97a31374051bde637ddfa1cd74eeb216cff89c6ae5448dae434bcea8f7b

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