No commit activity in last 3 years
No release in over 3 years
A Liquid Block which lets you use markdown in any Jekyll template.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.3
>= 0

Runtime

~> 2.0
 Project Readme

Jekyll Markdown Block

Gem Version Build Status

Why? Because you should be able to:

  • Write markdown anywhere.
  • {% include %} markdown files anywhere.

Installation

Add this line to your application's Gemfile under the :jekyll_plugins group:

group :jekyll_plugins do
  gem 'jekyll-markdown-block'
end

And then execute:

$ bundle

Next add this to your plugins folder to automatically load any Jekyll plugins in your :jekyll_plugins group.

# in _plugins/bundler.rb
require "bundler/setup"
Bundler.require(:jekyll_plugins)

Or you can just add a ruby file to your Jekyll plugins directory with the line require "jekyll-markdown-block"

Usage

Embed Markdown in HTML

Drop some markdown in your html, and it will render nicely

<!-- Some random HTML file-->
<div>
{% markdown %}

## That's right folks!

Markdown in your `HTML`!

- Any template
- Any time

{% endmarkdown %}
</div>

Convert includes with markdown

Correctly render markdown files which are included in an HTML page.

<!-- Another random HTML file-->

<div>
{% markdown %}{% include coolcat.md %}{% endmarkdown %}
</div>

That's pretty much it. Have fun!

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request