# Example

Have you:

- successfully installed MarkdownX?
- followed the instructions on how to get started?

If so, you are set for the next step. Here you can find comprehensive examples of how to use different MarkdownX features to your advantage.

## Model

This is how you implement a MarkdownX field in your models. In your `app/models.py`:

    from markdownx.models import MarkdownxField

    class MyModel(models.Model):
        myfield = MarkdownxField()

... and then, include the form media in the relevant template using `{{ form.media }}`, like so:

    <form method="POST" action="">{% csrf_token %}
        {{ form }}
    </form>

    {{ form.media }}

Note

The field extends Django's own TextField and is saved in the database accordingly.

## Form

You can also implement MarkdownX through the forms. This will be done in your `app/forms.py` as follows:

    from markdownx.fields import MarkdownxFormField

    class MyForm(forms.Form):
        myfield = MarkdownxFormField()

... and then, include a form's required media in the template using `{{ form.media }}`:

    <form method="POST" action="">{% csrf_token %}
        {{ form }}
    </form>

    {{ form.media }}

## Django Admin

When using included `MarkdowxModel` class in your models, just use `MarkdownxModelAdmin` in your `app/admin.py` as follows:

    from django.contrib import admin
    from markdownx.admin import MarkdownxModelAdmin
    from .models import MyModel

    admin.site.register(MyModel, MarkdownxModelAdmin)

GitHub « Previous Next »