Pandoc Web

Pandoc Web is a client-side app that lets you edit, preview and convert between documents written in various markup languages in your browser. Functions are based on Pandoc your swiss-army knife for converting files.

Table of contents

• Manual
  • Input formats
  • Output formats
  • Options
    • Standalone
    • TOC
    • Number sections
    • Citeproc
    • Text wrap
    • Code highlighting
    • Math render
    • Use markdown example
    • Use file as input
    • Use file for output
• Installation
  • Prerequisites
  • Install Pandoc Web
• Links

Manual

Input formats

Output formats

Options

You have some options. For more detailed informations see pandocs manual.

Standalone

Produce output with an appropriate header and footer (e.g. a standalone HTML, LaTeX, TEI, or RTF file, not a fragment).

This option is set automatically for PDF, EPUB, FictionBook2 e-book, Word docx and OpenOffice text document odt output.

TOC

Include an automatically generated table of contents (or, in the case of latex, context, docx, odt, opendocument, rst, or ms, an instruction to create one) in the output document. This option checks option ‘Standalone’ as this is required.

Option ‘TOC’ has no effect on roff man, DocBook4, DocBook5 or all JATS XML output.

Number sections

Number section headings in LaTeX, ConTeXt, HTML, Word docx, roff ms, EPUB or Preview output.

Citeproc

Process the citations in the file, replacing them with rendered citations and adding a bibliography. Citation processing will not take place unless bibliographic data is supplied through the bibliography field in metadata, or via a references section in metadata containing a list of citations in CSL YAML format with Markdown formatting.

For more information see the pandoc manual section on Citations.

Text wrap

Determine how text is wrapped in the output (the source code, not the rendered version). With Auto pandoc will attempt to wrap lines to the column width (72). With None pandoc will not wrap lines at all. With Preserve pandoc will attempt to preserve the wrapping from the source document (that is, where there are nonsemantic newlines in the source, there will be nonsemantic newlines in the output as well). In Jupyter notebook (ipynb) output, this option affects wrapping of the contents of markdown cells.

Code highlighting

Specifies the coloring style to be used in highlighted source code. None disables syntax highlighting for code blocks and inlines. Other options are Pygments, Breeze, Espresso, Haddock, Kate, Monochrome, Tango and Zenburn.

Math render

The default Plain is to render TeX math as far as possible using Unicode characters. Formulas are put inside a span with class="math", so that they may be styled differently from the surrounding text if needed. However, this gives acceptable results only for basic math, usually you will want to use another of the options GladTeX, KaTeX, MathJax, MathML or WebTeX.

For more information see the pandoc manual section on Math rendering in HTML.

Use markdown example

To just play a bit with all the options above click the button Use markdown example.

Use file as input

Instead of typing text in the input field provide an input file. Remember to choose the correct input format too.

The input file is sent to the server for conversion and then immediately deleted on the server.

Use file for output

Normally all output will be seen on the output field. But you can create a file by checking it. After converting you will get a download link offered.

After conversion and sending back to the client the output file is also immediately deleted from the server.

Installation

Prerequisites

Of course your server needs Pandoc. You find Pandoc installing instructions on github.

To create PDFs you need ConTeXt. You can find informations on how to install ConTeXt.

You might also like to read the security instructions at How to increase security for pandoc on server. But don't panic, these advices are implemented in the code.

Install Pandoc Web

The easiest way to get a installation of Pandoc Web itself is to clone this repo.

$ git clone https://github.com/SimpelMe/pandoc-web

Then rename the localConfig_example.php to localConfig.php and set both pathes to your pandoc and context on your server.

// both pathes to pandoc and to context (context is needed for pdf)
define('PATH', '/Users/me/.pandoc/bin/:/Users/me/context/tex/texmf-osx-arm64/bin/');

It sets the value of the servers environment variable PATH.

Links

• Pandoc
• Pandoc installing instructions on github
• ConTeXt
• How to install context
• How to increase security for pandoc on server