Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dperetti/Django-wagtailmedium
A Medium Editor integration for the Wagtail CMS.
https://github.com/dperetti/Django-wagtailmedium
django wagtail
Last synced: about 2 months ago
JSON representation
A Medium Editor integration for the Wagtail CMS.
- Host: GitHub
- URL: https://github.com/dperetti/Django-wagtailmedium
- Owner: dperetti
- License: other
- Created: 2017-02-02T10:53:59.000Z (over 7 years ago)
- Default Branch: develop
- Last Pushed: 2021-05-09T10:52:47.000Z (over 3 years ago)
- Last Synced: 2024-06-29T10:05:51.286Z (3 months ago)
- Topics: django, wagtail
- Language: Python
- Homepage:
- Size: 1.31 MB
- Stars: 18
- Watchers: 2
- Forks: 3
- Open Issues: 6
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGES.txt
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-wagtail - Wagtail Medium Editor - A customizable Medium Editor for Wagtail, with link anchors support. (Apps / Rich text editor extensions)
README
=====================
Django-WagtailMedium
=====================
Wagtailmedium is a Medium Editor integration for the Wagtail CMS.
.. image:: https://raw.githubusercontent.com/dperetti/Django-wagtailmedium/master/Documentation.codestory/data/1a179310-b817-11e6-9f99-f91930e01b01.png
**Note**: A more detailed documentation is available in `.codestory `_ format, along with a sample project to fiddle with.
Features
--------
- Compatible with Wagtail internal links, plus the ability to add url fragments.
- Configurable from the Django settings.
- Ability to create custom buttons (ex: text marker).
Install
-------
1. **Install from pip**::
pip install django-wagtailmedium
2. **Add wagtailmedium to your apps**::
INSTALLED_APPS = [
...
'wagtailmedium',
]
3. **Add a wagtailmedium widget to ``WAGTAILADMIN_RICH_TEXT_EDITORS``** (implemented by wagtail, undocumented yet)
::
WAGTAILADMIN_RICH_TEXT_EDITORS = {
'default': {
'WIDGET': 'wagtail.wagtailadmin.rich_text.HalloRichTextArea'
},
'medium': {
'WIDGET': 'wagtailmedium.rich_text.MediumRichTextArea',
'OPTIONS': {
'custom_buttons': {
'code': {
'contentDefault': 'Code',
'contentFA': '',
'tag': 'code',
'className': 'code', # optional
},
'test': {
'contentDefault': 'Test',
'contentFA': '',
'tag': 'span',
'className': 'test', # optional
},
},
'medium': { # https://github.com/yabwe/medium-editor#options-example
# 'buttonLabels': 'fontawesome',
'toolbar': {
'buttons': [ # https://github.com/yabwe/medium-editor#all-buttons
'bold', 'italic', 'underline',
'code',
'test',
'link',
'linkdoc',
'h2', 'h3', 'orderedlist', 'unorderedlist', 'strikethrough'
]
},
},
},
},
}
4. **Register whitelister element rules**
This wagtail `hook `_ defines which HTML elements are allowed in rich text areas.
``wagtail_hooks.py``::
from wagtail.wagtailcore import hooks
from wagtail.wagtailcore.whitelist import attribute_rule, allow_without_attributes
# http://docs.wagtail.io/en/v1.7/reference/hooks.html#construct-whitelister-element-rules
@hooks.register('construct_whitelister_element_rules') # #7bFcf#
def whitelister_element_rules():
return {
'u': allow_without_attributes,
'span': attribute_rule({'class': True}),
'code': allow_without_attributes,
'blockquote': allow_without_attributes,
}
5. **Use wagtailmedium in a RichTextField of your model**
``models.py``::
from wagtail.wagtailcore.models import Page, StreamField, RichTextField
class HomePage(Page):
# a default, Hallo editor
hallo = RichTextField(blank=True)
# a medium editor
medium = RichTextField(editor='medium', blank=True)