Skip to content

feat: support tailwind ui #284

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from
Draft

feat: support tailwind ui #284

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
300900c
feat: support tailwind ui
agusmakmun Aug 28, 2025
e498be4
feat: update functionalities and demo
agusmakmun Aug 29, 2025
337b597
fix: emoji and style
agusmakmun Aug 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
90 changes: 87 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@

📖 **Documentation:** https://django-markdown-editor.readthedocs.io

**Martor** is a Markdown Editor plugin for Django, supported for _Bootstrap_ & _Semantic-UI_.
**Martor** is a Markdown Editor plugin for Django, supported for _Bootstrap_, _Semantic-UI_ & _Tailwind CSS_.


### Features

* Live Preview
* Integrated with [_Ace Editor_](https://ace.c9.io)
* Supported with [_Bootstrap_](https://getbootstrap.com) and [_Semantic-UI_](https://semantic-ui.com)
* Supported with [_Bootstrap_](https://getbootstrap.com), [_Semantic-UI_](https://semantic-ui.com) and [_Tailwind CSS_](https://tailwindcss.com)
* Supported Multiple Fields [_fixed this issue_](https://github.com/agusmakmun/django-markdown-editor/issues/3)
* Upload Images to imgur.com _(via API)_ and [custom uploader][13]
* Direct Mention users `@[username]` - _(requires user to logged in)_.
Expand Down Expand Up @@ -86,7 +86,7 @@ Please register your application at https://api.imgur.com/oauth2/addclient
to get `IMGUR_CLIENT_ID` and `IMGUR_API_KEY`.

```python
# Choices are: "semantic", "bootstrap"
# Choices are: "semantic", "bootstrap", "tailwind"
MARTOR_THEME = 'bootstrap'

# Global martor settings
Expand Down Expand Up @@ -335,6 +335,90 @@ Different with *Template Renderer*, the *Template Editor Form* have more css & j
```


#### Tailwind CSS Theme

When using `MARTOR_THEME = 'tailwind'`, include the required CSS and JavaScript files:

**Template Renderer (Tailwind):**

```html
{% extends "base.html" %}
{% load static %}
{% load martortags %}

{% block css %}
<link href="{% static 'plugins/css/ace.min.css' %}" type="text/css" media="all" rel="stylesheet" />
<link href="{% static 'plugins/css/tailwind.min.css' %}" type="text/css" media="all" rel="stylesheet" />
<link href="{% static 'martor/css/martor.tailwind.min.css' %}" type="text/css" media="all" rel="stylesheet" />
{% endblock %}

{% block content %}
<div class="container mx-auto px-4 py-8">
<div class="martor-preview bg-white rounded-lg shadow-sm p-6">
<h1 class="text-3xl font-bold text-gray-900 mb-4">{{ post.title }}</h1>
<div class="prose prose-sm max-w-none">
{{ post.description|safe_markdown }}
</div>
</div>
</div>
{% endblock %}

{% block js %}
<script type="text/javascript" src="{% static 'plugins/js/highlight.min.js' %}"></script>
<script>
document.querySelectorAll('.martor-preview pre code').forEach((block) => {
hljs.highlightBlock(block);
});
</script>
{% endblock %}
```

**Template Editor Form (Tailwind):**

```html
{% extends "base.html" %}
{% load static %}

{% block css %}
<link href="{% static 'plugins/css/ace.min.css' %}" type="text/css" media="all" rel="stylesheet" />
<link href="{% static 'plugins/css/tailwind.min.css' %}" type="text/css" media="all" rel="stylesheet" />
<link href="{% static 'martor/css/martor.tailwind.min.css' %}" type="text/css" media="all" rel="stylesheet" />
{% endblock %}

{% block content %}
<div class="container mx-auto px-4 py-8">
<form class="bg-white rounded-lg shadow-sm p-6" method="post">{% csrf_token %}
<div class="mb-6">
<label class="block text-sm font-medium text-gray-700 mb-2">{{ form.title.label }}</label>
{{ form.title }}
</div>
<div class="mb-6">
<label class="block text-sm font-medium text-gray-700 mb-2">{{ form.description.label }}</label>
{{ form.description }}
</div>
<div class="flex justify-end">
<button class="bg-blue-600 hover:bg-blue-700 text-white font-medium py-2 px-4 rounded-md transition-colors">
Save Post
</button>
</div>
</form>
</div>
{% endblock %}

{% block js %}
<script type="text/javascript" src="{% static 'plugins/js/ace.js' %}"></script>
<script type="text/javascript" src="{% static 'plugins/js/mode-markdown.js' %}"></script>
<script type="text/javascript" src="{% static 'plugins/js/ext-language_tools.js' %}"></script>
<script type="text/javascript" src="{% static 'plugins/js/theme-github.js' %}"></script>
<script type="text/javascript" src="{% static 'plugins/js/typo.js' %}"></script>
<script type="text/javascript" src="{% static 'plugins/js/spellcheck.js' %}"></script>
<script type="text/javascript" src="{% static 'plugins/js/highlight.min.js' %}"></script>
<script type="text/javascript" src="{% static 'plugins/js/emojis.min.js' %}"></script>
<script type="text/javascript" src="{% static 'martor/js/martor.tailwind.min.js' %}"></script>
{% endblock %}
```


### Custom Uploader

If you want to save the images uploaded to your storage,
Expand Down
Loading