Skip to content

TrestleAdmin/trestle-simplemde

Repository files navigation

Trestle SimpleMDE Integration (trestle-simplemde)

SimpleMDE integration plugin for the Trestle admin framework

Getting Started

These instructions assume you have a working Trestle application. To integrate trestle-simplemde, first add it to your application's Gemfile:

gem 'trestle-simplemde'

Run bundle install, and then restart your Rails server.

To add a SimpleMDE editor to your form, use the editor (or simplemde) field type:

Trestle.resource(:articles) do
  form do |article|
    editor :content
  end
end

SimpleMDE can be configured by defining options within config/initializers/trestle.rb. See https://github.com/sparksuite/simplemde-markdown-editor#configuration for the full list of configuration options. Configuration keys will be camel-cased when passed to SimpleMDE.

Trestle.configure do |config|
  config.simplemde.configure do |c|
    c.toolbar = false

    c.autosave.enabled = true
    c.autosave.unique_id = "MyUniqueID"
  end
end

Rendering Content

This plugin handles the back-end content editing of markdown content but does not make any decisions on how you should render the content within the front-end of your app.

The example below shows how this could be done using the redcarpet gem.

<% markdown = Redcarpet::Markdown.new(Redcarpet::Render::HTML.new) %>
<%= markdown.render(@article.content) %>

License

The gem is available as open source under the terms of the LGPLv3 License.

About

SimpleMDE integration plugin for the Trestle admin framework

Resources

License

Stars

Watchers

Forks

Packages

No packages published