Metadata-Version: 2.1
Name: PythonVuetifyMarkdown
Version: 0.1.3
Summary: Adds Vuetify typography classes to various tags
Home-page: https://gitlab.com/robertjauss/python-vuetify-markdown
Author: Robert Jauss
Author-email: robertjauss@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.4
Description-Content-Type: text/markdown
Requires-Dist: markdown (>=2.5)

# Python Vuetify Markdown

This is an extension for [Python-Markdown](https://github.com/Python-Markdown/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
<code>pip install PythonVuetifyMarkdown</code>

# 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.

```python
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](https://vuetifyjs.com/en/styles/typography).
* **&lt;h1&gt;** &rarr; &lt;h1 class="display-4"&gt;
* **&lt;h2&gt;** &rarr; &lt;h1 class="display-3"&gt;
* **&lt;h3&gt;** &rarr; &lt;h1 class="display-2"&gt;
* **&lt;h4&gt;** &rarr; &lt;h1 class="display-1"&gt;
* **&lt;h5&gt;** &rarr; &lt;h1 class="headline"&gt;
* **&lt;h6&gt;** &rarr; &lt;h1 class="title"&gt;
* **&lt;p&gt;** &rarr; &lt;h1 class="body-1"&gt;

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

