@pubpub/pubpub-pandoc-converter

ppub-pandoc-convert

A converter from PubPub (ProseMirror) to Pandoc.

Table of Contents

1. Installation
2. Usage
   1. Converting to Pandoc
      1. Supported Metadata
   2. Converting to Ppub
3. Testing

Installation

npm install @pubpub/pubpub-pandoc-converter

var ppubToPandoc = require('@pubpub/pubpub-pandoc-converter').ppubToPandoc.

Usage

Converting to Pandoc

ppubToPandoc(file, options)

options.bibFile (what the bib file will be saved as)

options.metadata all the metadata stored in the converted pandoc file. Possible keys are listed below.

Supported Metadata

authors (an array of strings)
title
institute
degree
date
supervisor-name
supervisor-title
department-chairman-name
department-chairman-title
acknowledgements
abstract
degree-month
degree-year
thesis-date
department
pub-readers (an array of JSON objects with strings name, title, and affiliation)

Converting to Ppub

Converting to Ppub from Pandoc is a work in progress.

Testing

cd into this package directory and run

npm run test