Skip to main content

Adds Vuetify typography classes to various tags

Project description

Python Vuetify Markdown

This is an extension for Python-Markdown created for those who combine Python, Markdown, Vue, and Vuetify. I've been using this combination in several projects, and finally came across a need to process Markdown code, and keep it styled with Vuetify. Rather than McGuyver some solution in, I settled on a simple extension to do the heavy lifting.

The code is dead simple, and can be modified or extended to fit your needs.

Installation

pip install PythonVuetifyMarkdown

Usage

Here's a quick example of usage within a Django project. We have a Page model for custom pages, and a function to return the content parsed through Markdown.

from django.db import models
from django.utils.html import mark_safe
import markdown
from python_vuetify_markdown import PythonVuetifyMarkdown


class Page(models.Model):
    title = models.CharField(max_length=200)
    body = models.TextField()

    def get_body_as_markdown(self):
        return mark_safe(markdown.markdown(self.body, extensions=[PythonVuetifyMarkdown()]))

With this, you can create a Page object, and when displaying the body, you can use Page.get_body_as_markdown() to pass in the Markdown-formatted code.

Features

Currently, this extension modifies H1 to H6 tags and P tags. The styles can be found on the Vuetify Typography page.

  • <h1> → <h1 class="display-4">
  • <h2> → <h1 class="display-3">
  • <h3> → <h1 class="display-2">
  • <h4> → <h1 class="display-1">
  • <h5> → <h1 class="headline">
  • <h6> → <h1 class="title">
  • <p> → <h1 class="body-1">

Support

There is none. This is a small side project, like 30 minutes of research and work went into it. Good luck.

Project details


Download files

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

Files for PythonVuetifyMarkdown, version 0.1.3
Filename, size File type Python version Upload date Hashes
Filename, size PythonVuetifyMarkdown-0.1.3-py3-none-any.whl (4.0 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size PythonVuetifyMarkdown-0.1.3.tar.gz (2.6 kB) File type Source Python version None Upload date Hashes View hashes

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 DigiCert DigiCert EV certificate StatusPage StatusPage Status page