zooppa/administrate-field-simple_markdown

# Administrate::Field::SimpleMarkdown

[![No Maintenance Intended](https://unmaintained.tech/badge.svg)](https://unmaintained.tech/) [![Build status](https://github.com/zooppa/administrate-field-simple_markdown/actions/workflows/build.yml/badge.svg)](https://github.com/zooppa/administrate-field-simple_markdown/actions/workflows/build.yml)
[![Code Climate](https://codeclimate.com/github/zooppa/administrate-field-simple_markdown/badges/gpa.svg)](https://codeclimate.com/github/zooppa/administrate-field-simple_markdown)

---

### 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](https://raw.githubusercontent.com/zooppa/administrate-field-simple_markdown/master/demo.gif)

## Usage

Add it to your `Gemfile`:

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

Run:

```bash
$ bundle install
```

Add to your `FooDashboard`:

```ruby
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](https://github.com/Ionaru/easy-markdown-editor#options-list).

## About

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

See also the list of [contributors](https://github.com/zooppa/administrate-field-simple_markdown/contributors) who participated in this project.

[administrate]: https://github.com/thoughtbot/administrate
[easymde]: https://github.com/Ionaru/easy-markdown-editor
[zooppa]: https://www.zooppa.com/