Skip to content
This repository has been archived by the owner on Mar 29, 2023. It is now read-only.

zooppa/administrate-field-simple_markdown

Repository files navigation

Administrate::Field::SimpleMarkdown

No Maintenance Intended Build status Code Climate


IMPORTANT NOTICE

This gem is not actively maintained anymore.

If you’re interested in taking over and steward the project moving forward, please get in touch.


A plugin to edit Markdown text in Administrate using EasyMDE.

Demo

Usage

Add it to your Gemfile:

gem 'administrate-field-simple_markdown', '~> 0.7.0'

Run:

$ bundle install

Add to your FooDashboard:

ATTRIBUTE_TYPES = {
  bar: Field::SimpleMarkdown.with_options({
    safe_links_only: true,
    filter_html: true,
    with_toc_data: true,
    hard_wrap: true,
    link_attributes: { rel: 'follow' },
    autolink: true,
    tables: true,
    no_intra_emphasis: true,
    strikethrough: true,
    highlight: true,
    space_after_headers: true,
    easymde_options: {
      placeholder: 'Type here...',
      spell_checker: false,
      hide_icons: %w[guide heading]
    }
  })
}.freeze

You can pass EasyMDE a configuration object via the easymde_options option. Check the full list of available options.

About

Administrate::Field::SimpleMarkdown is maintained by Zooppa.

See also the list of contributors who participated in this project.