Giter VIP home page Giter VIP logo

jekyll-markdown-block's Introduction

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

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.