项目作者: belak

项目描述 :
Commonmark support for Wagtail
高级语言: JavaScript
项目地址: git://github.com/belak/wagtail-commonmark.git
创建时间: 2019-10-04T17:45:44Z
项目社区:https://github.com/belak/wagtail-commonmark

开源协议:MIT License

下载


wagtail-commonmark: CommonMark fields and blocks for Wagtail

Tired of annoying rich text editors getting in the way of your content
input? Wish Wagtail worked more like a wiki? Well, now it can.

wagtail-commonmark provides CommonMark field support for Wagtail.
Specifically, it provides:

  • A wagtailcommonmark.blocks.CommonMarkBlock for use in streamfields.
  • A wagtailcommonmark.fields.CommonMarkField for use in page models.
  • A wagtailcommonmark.edit_handlers.CommonMarkPanel for use in the editor interface.
  • A wagtailcommonmark.jinja2tags.commonmark extension for use in jinja2 templates.
  • A commonmark template tag.

Installation

Alpha release is available on Pypi - https://pypi.org/project/wagtail-commonmark/ - installable via pip install wagtail-commonmark.

Using it

Add it to INSTALLED_APPS:

  1. INSTALLED_APPS += [
  2. 'wagtailcommonmark',
  3. ]

Use it as a StreamField block:

  1. from wagtailcommonmark.blocks import CommonMarkBlock
  2. class MyStreamBlock(StreamBlock):
  3. markdown = CommonMarkBlock(icon="code")

Or use as a page field:

  1. from wagtailcommonmark.edit_handlers import CommonMarkPanel
  2. from wagtailcommonmark.fields import CommonMarkField
  3. class MyPage(Page):
  4. body = CommonMarkField()
  5. content_panels = [
  6. FieldPanel("title", classname="full title"),
  7. CommonMarkPanel("body"),
  8. ]

And render the content in a template:

  1. {% load wagtailcommonmark %}
  2. <article>
  3. {{ self.body|commonmark }}
  4. </article>