Skip to content

mfenner/jekyll-pandoc

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

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

jekyll-pandoc

Build Status Gem Version Code Climate

Pandoc markdown converter for the Jekyll static site generator. Originally based on jekyll-pandoc-plugin by David Sanson.

Jekyll-pandoc uses the pandoc-ruby gem as a Ruby wrapper for Pandoc.

Requirements

  • Jekyll, version 3.0 or higher
  • Pandoc, version 1.15 or higher

Install version 1.0.2 for older jekyll versions

Installation

Run bundle install after adding the gem to your Jekyll Gemfile:

gem "jekyll-pandoc"

If you are not using Bundler, install as gem:

[sudo] gem install jekyll-pandoc

Configuration

Add the gem to the Jekyll _config.yml:

gems:
  - jekyll-pandoc

Change the markdown processor in the Jekyll _config.yml:

markdown: Pandoc

Additional pandoc options can be provided in the Jekyll _config.yml:

pandoc:
  extensions:
    - normalize
    - smart
    - mathjax
    - csl: _styles/apa.csl
    - bibliography: bibliography/references.bib

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

License

MIT License.

About

Jekyll Pandoc markdown converter as Ruby gem

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages