Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
Jekyll Markdown Tag
=begin
Jekyll tag to include Markdown text from _includes directory preprocessing with Liquid.
Usage:
{% markdown <filename> %}
Dependency:
- kramdown
=end
module Jekyll
class MarkdownTag < Liquid::Tag
def initialize(tag_name, text, tokens)
super
@text = text.strip
end
require "kramdown"
def render(context)
tmpl = File.read File.join Dir.pwd, "_includes", @text
site = context.registers[:site]
tmpl = (Liquid::Template.parse tmpl).render site.site_payload
html = Kramdown::Document.new(tmpl).to_html
end
end
end
Liquid::Template.register_tag('markdown', Jekyll::MarkdownTag)
@dr3s

This comment has been minimized.

Copy link

@dr3s dr3s commented Jul 24, 2013

neither this nor render_partial work for me

@mignev

This comment has been minimized.

Copy link

@mignev mignev commented Dec 2, 2013

Hi thanks for the gist :) I fork it and make some small change to work with markdown engine that your Jekyll installation works :) ... i mean without other dependencies. This is the link of my gist: https://gist.github.com/mignev/7759676

Thanks once again :)

@moble

This comment has been minimized.

Copy link

@moble moble commented Nov 7, 2014

I've mentioned this on @mignev's fork, but it also applies to this version:

Something weird seems to happen to the markdown with this plugin. For example, when using fenced code blocks, the newlines seem to disappear. I've also added support for MathJax to my installation, and the backslashes get removed. Explicit inclusion along the lines of

{% capture my-include %}{% include test.md %}{% endcapture %}
{{ my-include | markdownify }}

Doesn't have these problems. Any ideas how to work around these while still using the plugin?

@kristiannordestgaard

This comment has been minimized.

Copy link

@kristiannordestgaard kristiannordestgaard commented Aug 13, 2015

Hi,

This is my current code:

{% if member.brief %}
{% include /briefs/{{ member.brief }} %}
{% endif %}

I need to change this so it uses the markdown command instead of include, but

{% if member.brief %}
{% markdown /briefs/{{ member.brief }} %}
{% endif %}

Gives me a "file not found" error. How can I make it work?

Best,
Kristian

@kamlekar

This comment has been minimized.

Copy link

@kamlekar kamlekar commented Aug 27, 2015

Even after inserting this code in _plugins directory, I am getting page build error:

The tag markdown in _posts/2015-08-26-compiling-html-templates-to-html-pages.md is not a recognized Liquid tag.

I am using kramdown markdown.

Please help.

@c100k

This comment has been minimized.

Copy link

@c100k c100k commented Nov 15, 2015

@kamlekar I've just had the same problem. I forgot to restart my site with jekyll serve.

@apburton84

This comment has been minimized.

Copy link

@apburton84 apburton84 commented Feb 19, 2016

How would variables be passed into the included markdown ?

{% markdown query_parameters.md param="value" %}

Liquid Exception: No such file or directory - _includes/query_parameters.md param="value" in _posts/2016-01-22-user.markdown
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.