A thin and simple pandoc wrapper function
npm install simple-pandocA thin and simple pandoc wrapper function
simple-pandoc provides probably the thinest and simplest Node.js binding for
pandoc. It just wraps the pandoc
command into JavaScript APIs.
It focuses on a very simple use case, and may not provide complicated
functionalities. If they are needed, please check out
other libraries on npm.
simple-pandoc doesn't provide pandoc itself. Please ensure that pandoc
is installed and executable. To install pandoc, please refer to the
Installing section in the pandoc
documentation.
To install simple-pandoc, use npm.
```
$ npm install simple-pandoc
`js`
const pandoc = require('simple-pandoc');
pandoc(from, to, ...opts)
- from: String a format specified in the pandoc documentationto
- : String a format specified in the pandoc documentationopts
- : ...String options specified in the pandoc documentationFunction
- return: a converter function
Example:
`js`
const htmlToMarkdown = pandoc('html', 'markdown', '--no-highlight', '--key=value', ...);
converter(content)
- content: String|Buffer content in the from format to be convertedPromise
- return: promised content in the to format
Example:
`js
const htmlToMarkdown = pandoc('html', 'markdown');
htmlToMarkdown(fs.readFileSync('index.html'))
.then(md => {
console.log(md.toString());
});
`
Even better with async/await:
`js
const htmlToMarkdown = pandoc('html', 'markdown');
async function convert() {
const html = fs.readFileSync('index.html');
const md = await htmlToMarkdown(html);
console.log(md.toString());
}
convert();
`
converter.stream(readStream)
- readStream: Readablefrom
a stream conveying content in the format
- return: Readable
a stream conveying converted content in the to format
Example:
`js
const htmlToMarkdown = pandoc('html', 'markdown');
const inputStream = fs.createReadStream('index.html');
const outputStream = fs.createWriteStream('index.md');
htmlToMarkdown.stream(inputStream).pipe(outputStream);
``
MIT © Jun