Adds Markdown fields, blocks, and inline previews to Wagtail CMS, replacing rich text editors with a wiki-like editing experience.
wagtail-markdown is a Django package that adds native Markdown support to the Wagtail CMS. It provides field types and StreamField blocks for writing content in Markdown, along with an inline preview editor, enabling a wiki-like editing experience within Wagtail. It solves the problem of clunky rich text editors by offering a clean, efficient Markdown interface for content creation.
Wagtail developers and content editors who prefer Markdown over traditional rich text editors, especially those building content-heavy sites where wiki-style editing improves productivity.
Developers choose wagtail-markdown because it seamlessly integrates Markdown into Wagtail's admin interface with live previews, custom Wagtail-aware link syntax, and extensible configuration. It replaces the default rich text editor with a faster, more developer-friendly editing experience.
Markdown support for Wagtail
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.
Provides MarkdownField for page models and MarkdownBlock for StreamFields, allowing Markdown content to be embedded directly into Wagtail's admin and templates with minimal setup.
Integrates EasyMDE for inline Markdown previews in the Wagtail admin, making content editing faster and more intuitive for developers and editors who prefer wiki-style workflows.
Extends Markdown with syntax for linking to Wagtail pages, documents, and images using IDs, with support for classes and image renditions, enhancing CMS-specific functionality.
Allows configuration of allowed HTML, styles, attributes, and python-markdown extensions via a settings dictionary, offering flexibility for security and feature needs.
Requires manual configuration of FontAwesome if not using the default CDN, involving custom wagtail hooks and potential conflicts with other packages like Wagtail FontAwesome.
Relies on Pygments for syntax highlighting and EasyMDE for the editor, adding maintenance overhead and potential version compatibility issues with Wagtail updates.
The old title-based link syntax is unreliable and slated for removal, forcing users to migrate to ID-based links, which can break existing content if not updated.