# node-pandoc [](https://badge.fury.io/js/node-pandoc) [](http://www.sugarhai.com/images/sprinklepoo-gif.gif)
Run Pandoc from NodeJS. Pandoc installation is required.
## Install
```sh
# If using as a dependancy in your module
npm install node-pandoc --save
# ...or for use in your project
npm install node-pandoc --save-dev
```
*Prior to using node-pandoc, you must [install Pandoc](http://pandoc.org/installing.html) by [John MacFarlane](http://johnmacfarlane.net/).*
## What’s Pandoc?
> If you need to convert files from one markup format into another, pandoc is your swiss-army knife. Pandoc can convert documents in [markdown](http://daringfireball.net/projects/markdown/), [reStructuredText](http://docutils.sourceforge.net/docs/ref/rst/introduction.html), [textile](http://redcloth.org/textile), [HTML](http://www.w3.org/TR/html40/), [DocBook](http://www.docbook.org/), [LaTeX](http://www.latex-project.org/), [MediaWiki markup](http://www.mediawiki.org/wiki/Help:Formatting), [TWiki markup](http://twiki.org/cgi-bin/view/TWiki/TextFormattingRules), [OPML](http://dev.opml.org/spec2.html), Emacs [Org-Mode](http://orgmode.org/), [Txt2Tags](http://txt2tags.org/), Microsoft Word [docx](http://www.microsoft.com/interop/openup/openxml/default.aspx), LibreOffice [ODT](http://en.wikipedia.org/wiki/OpenDocument), [EPUB](http://en.wikipedia.org/wiki/EPUB), or [Haddock markup](http://www.haskell.org/haddock/doc/html/ch03s08.html) to
>
> * HTML formats: XHTML, HTML5, and HTML slide shows using [Slidy](http://www.w3.org/Talks/Tools/Slidy), [reveal.js](http://lab.hakim.se/reveal-js/), [Slideous](http://goessner.net/articles/slideous/), [S5](http://meyerweb.com/eric/tools/s5/), or [DZSlides](http://paulrouget.com/dzslides/)
> * Word processor formats: Microsoft Word [docx](http://www.microsoft.com/interop/openup/openxml/default.aspx), OpenOffice/LibreOffice [ODT](http://en.wikipedia.org/wiki/OpenDocument), [OpenDocument XML](http://opendocument.xml.org/)
> * Ebooks: [EPUB](http://en.wikipedia.org/wiki/EPUB) version 2 or 3, [FictionBook2](http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1)
> * Documentation formats: [DocBook](http://www.docbook.org/), [GNU TexInfo](http://www.gnu.org/software/texinfo/), [Groff man pages](http://www.gnu.org/software/groff/groff.html), [Haddock markup](http://www.haskell.org/haddock/doc/html/ch03s08.html)
> * Page layout formats: [InDesign ICML](https://www.adobe.com/content/dam/Adobe/en/devnet/indesign/cs55-docs/IDML/idml-specification.pdf)
> * Outline formats: [OPML](http://dev.opml.org/spec2.html)
> * TeX formats: [LaTeX](http://www.latex-project.org/), [ConTeXt](http://www.pragma-ade.nl/), LaTeX Beamer slides
> * [PDF](http://en.wikipedia.org/wiki/Portable_Document_Format) via LaTeX
> * Lightweight markup formats: [Markdown](http://daringfireball.net/projects/markdown/) (including [CommonMark](http://commonmark.org/)), [reStructuredText](http://docutils.sourceforge.net/docs/ref/rst/introduction.html), [AsciiDoc](http://www.methods.co.nz/asciidoc/), [MediaWiki markup](http://www.mediawiki.org/wiki/Help:Formatting), [DokuWiki markup](https://www.dokuwiki.org/wiki:syntax), Emacs [Org-Mode](http://orgmode.org/), [Textile](http://redcloth.org/textile)
> * Custom formats: custom writers can be written in [lua](http://www.lua.org/)
## So Then What’s Node-Pandoc Do?
Node-Pandoc is simply a bridge between the Pandoc CLI (command-line interface) and NodeJS.
## Usage
**pandoc ( _src_ _args_ [_options_] _callback_ )**
### Parameters
#### src
> The _src_ can be either the location of a file (_./content/file.docx_) or a string of textual input ("_# Hello, Bananas_").
#### args
> The same list of arguments that pandoc accepts on the command line. Arguments are accepted as either a full String or as an Array.
#### options
> The options parameter accepts and passes along a Node Child_Process.Spawn object and is completely optional. View [a _complete_ list of Pandoc options on the Pandoc website](http://pandoc.org/README.html#options) or pull it from the command-line by typing:
```$ pandoc -h```
#### callback
> Function that call it called back with the parameters of (_error_, _result_).
### Examples of Using Node-Pandoc
Converting a word.docx file to a markdown.md
```js
// In EcmaScript 5...
var nodePandoc = require('node-pandoc');
var src, args, callback;
src = './word.docx';
// Arguments can be either a single string:
args = '-f docx -t markdown -o ./markdown.md';
// Or in an array of strings -- careful no spaces are present:
args = ['-f','docx','-t','markdown','-o','markdown.md'];
// Set your callback function
callback = function (err, result) {
if (err) {
console.error('Oh Nos: ',err);
}
// For output to files, the 'result' will be a boolean 'true'.
// Otherwise, the converted value will be returned.
console.log(result);
return result;
};
// Call pandoc
nodePandoc(src, args, callback);
```
```js
// In ES-6 (ES-2015)
import nodePandoc from 'node-pandoc'
let src = './word.docx';
// Arguments can be either a single String or in an Array
let args = '-f docx -t markdown -o ./markdown.md';
// Set your callback function
const callback = (err, result)=> {
if (err) console.error('Oh Nos: ',err)
return console.log(result), result
}
// Call pandoc
nodePandoc(src, args, callback);
```
Converting a word.docx file and returning HTML.
```js
var pandoc = require('node-pandoc'),
src = './word.docx',
// Arguments in either a single String or as an Array:
args = '-f docx -t html5';
// Set your callback function
callback = function (err, result) {
if (err) console.error('Oh Nos: ',err);
// Without the -o arg, the converted value will be returned.
return console.log(result), result;
};
// Call pandoc
pandoc(src, args, callback);
```
This also works the other way ’round; converting a bit of HTML and saving it as word.docx
```js
var pandoc = require('node-pandoc'),
src = 'Hello
It’s bananas
',
// Arguments in either a single String or as an Array:
args = '-f html -t docx -o word.docx';
// Set your callback function
callback = function (err, result) {
if (err) console.error('Oh Nos: ',err);
// Without the -o arg, the converted value will be returned.
return console.log(result), result;
};
// Call pandoc
pandoc(src, args, callback);
```
Or give-a-string/get-a-string: Markdown -> HTML
```js
var pandoc = require('node-pandoc'),
src = '# Hello \n\nIt\'s bananas',
// Arguments in either a single String or as an Array:
args = '-f markdown -t html';
// Set your callback function
callback = function (err, result) {
if (err) console.error('Oh Nos: ',err);
// Without the -o arg, the converted value will be returned.
return console.log(result), result;
};
// Call pandoc
pandoc(src, args, callback);
```
...and in reverse: HTML -> Markdown
```js
var pandoc = require('node-pandoc'),
src = 'Hello
It’s bananas
',
// Arguments in either a single String or as an Array:
args = '-f html -t markdown --atx-headers';
// NOTE: The --atx-headers flag set above will produce s as:
// # Hello
//
// ...while omitting --atx-headers flat will result in this style:
// Hello
// =====
// Set your callback function
callback = function (err, result) {
if (err) console.error('Oh Nos: ',err);
// Without the -o arg, the converted value will be returned.
return console.log(result), result;
};
// Call pandoc
pandoc(src, args, callback);
```
## One more thing...
It does URLs too.
```js
var pandoc = require('node-pandoc'),
src = 'https://www.npmjs.com/package/node-pandoc',
// Arguments in either a single String or as an Array:
args = '-f html -t docx -o node-pandoc.docx';
// Set your callback function
callback = function (err, result) {
if (err) console.error('Oh Nos: ',err);
// Without the -o arg, the converted value will be returned.
return console.log(result), result;
};
// Call pandoc
pandoc(src, args, callback);
```
> # ...it can go sideways and slantways and longways and backways and squareways and frontways and any other ways that you can think of.
## License
Copyright © Eric Shinn
Licensed under the MIT License