https://github.com/mfenner/jekyll-pandoc

Jekyll Pandoc markdown converter as Ruby gem
https://github.com/mfenner/jekyll-pandoc

Last synced: 3 months ago
JSON representation

Jekyll Pandoc markdown converter as Ruby gem

• Host: GitHub
• URL: https://github.com/mfenner/jekyll-pandoc
• Owner: mfenner
• License: mit
• Created: 2014-04-06T12:51:51.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2018-02-15T22:57:28.000Z (over 6 years ago)
• Last Synced: 2024-05-18T08:44:07.825Z (6 months ago)
• Language: Ruby
• Size: 36.1 KB
• Stars: 78
• Watchers: 6
• Forks: 10
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
jekyll-pandoc

=============

[![Build Status](https://travis-ci.org/mfenner/jekyll-pandoc.svg)](https://travis-ci.org/mfenner/jekyll-pandoc)

[![Gem Version](https://badge.fury.io/rb/jekyll-pandoc.svg)](http://badge.fury.io/rb/jekyll-pandoc)

[![Code Climate](https://codeclimate.com/github/mfenner/jekyll-pandoc.png)](https://codeclimate.com/github/mfenner/jekyll-pandoc)

[Pandoc](http://johnmacfarlane.net/pandoc/) markdown converter for the [Jekyll](https://github.com/jekyll/jekyll) static site generator. Originally based on [jekyll-pandoc-plugin](https://github.com/dsanson/jekyll-pandoc-plugin) by David Sanson.

Jekyll-pandoc uses the [pandoc-ruby](https://github.com/alphabetum/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](LICENSE).