This gem allows you to write static Rails views and partials using the Markdown syntax. No more editing prose in HTML!
Add the following to your Gemfile:
Now add views or partials ending in
# About This Site *Markdown code goes here ...*
Keep in mind that unlike static files dropped in
public, you still need a
matching route, such as
get ':action', :controller => :home, to route
<form>... dynamic code goes here ...</form> <div class="help"> <%= render :partial => "posts/edit_help" %> </div>
## How To Edit This text is written in **Markdown**. :-)
Note: If you are including Markdown partials from a Haml view,
inside your Markdown may be indented when Haml is not in "ugly" (production)
causing leading white-space to appear in development mode. To fix this, set
Haml::Template.options[:ugly] = true.
By default markdown-rails uses the
RDiscount parser. You can change this
config.render like so:
MarkdownRails.configure do |config| config.render do |markdown_source| # Return compiled HTML here ... end end
You might in particular want to use
Redcarpet, which allows you to enable
various aspects of GitHub Flavored
Markdown through its
parser options. To do so, add the
redcarpet gem to your Gemfile, and add the
following into a
MarkdownRails.configure do |config| markdown = Redcarpet::Markdown.new(Redcarpet::Render::HTML, :fenced_code_blocks => true, :autolink => true, ... etc ...) config.render do |markdown_source| markdown.render(markdown_source) end end
Despite Markdown being a static language, you should not use this gem to process untrusted Markdown views (or partials). In other words, do not add Markdown views from a source if you wouldn't trust Erb views from them.
It's not possible to embed Ruby code in the Markdown code. Unfortunately, you cannot simply chain template handlers (
.md.erb) like you can with asset handlers. This is reasonable if you consider that unlike assets, templates are precompiled not into strings but into Ruby code, which is then called every time the template is served. Still, the performance of modern Markdown parsers is good enough that you could afford to reparse the Markdown on every template view, so having Markdown with Erb in it should be possible in principle.
In the meantime, you can use HAML's :markdown filter to the same effect.
The only truly Markdown-specific code in the source is
.markdownfile name extensions. This gem can and should be generalized into a general-purpose static template gem, so that you can easily use other static templating languages in Rails. Perhaps tilt will come in useful.