Skip to content

AndrewVos/markdown-expander

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
lib
 
 
 
 
 
 
 
 
 
 
 
 
 
 

markdown-expander

A preprocessor for markdown that adds simple logic.

Why would you do this?????

This was written to be used on anmo.io, where users can create web pages with markdown, but also need to have some simple templating language.

Because users are going to be inputting content, I can't use any templating language that allows them to execute ruby code.

Liquid seemed far too complex and heavyweight for what I want and also didn't work well when mixed with markdown.

Installation

Add this line to your application's Gemfile:

gem 'markdown-expander'

And then execute:

$ bundle

Or install it yourself as:

$ gem install markdown-expander

Expressions

require "markdown-expander"

MarkdownExpander::Expander.new(
  "# Title: {{thing.title}}"
).render(
  thing: {title: "Hello"}
)
#=> "# Title: Hello"

Loops

require "markdown-expander"

template = <<-TEMPLATE
{{thing in stuff}}
# {{thing.title}}
{{end}}
TEMPLATE

MarkdownExpander::Expander.new(template).render(
  stuff: [ {title: "First!"}, {title: "Second!"} ]
)
#=> "# First!\n# Second!\n"

Logic

require "markdown-expander"

template = <<-TEMPLATE
{{animal in animals}}
  {{if animal.name == "cats"}}
# {{animal.name}} are the best!!!!!
  {{end}}
{{end}}
TEMPLATE

MarkdownExpander::Expander.new(template).render(
  animals: [ {name: "dogs"}, {name: "cats"} ]
)
#=> "# cats are the best!!!!!\n"

About

A preprocessor for markdown that adds simple logic

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages