Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Clone this wiki locally
- Web Services to Process Files by Pandoc
- Tools for Websites
- Other Wiki Pages
- Examples of uses of pandoc
- Atom Packages
- Scripts for using pandoc with BBEdit and TextWrangler, as well as Notepad++
- pandoc-mode for emacs, by Joost Kremers
- Mac OS X Services to invoke pandoc from any text editor
- Tool for using pandoc from Notepad++, courtesy of Ted Lilley
- R Markdown, using knitr and pandoc
- Sublime Text, a number of plugins available for Sublime Text via the plugin Package Control. See Plaintxt Productivity and Writing academic papers in Markdown using Pandoc for further details.
- TextMate bundle for pandoc, courtesy of David Sanson (for TextMate 2 only)
- Texts, Markdown WYSIWYM editor, is integrated with Pandoc.
- vim-pandoc project, integration with pandoc and utilities for vim, courtesy of Felipe Morales (fmoralesc) and others. Covers:
- vim syntax file for pandoc, courtesy of tao_zhyn
- vim HTML viewer use pandoc, by lambdalisue
- vim HTML viewer use pandoc, konqueror or firefox, by tex
- vim Unite BibTeX source for pandoc, by Mark Sprevak
- The Zim desktop wiki can export content to markdown using pandoc extensions (need zim version 0.55 and up) the opened file as input.
- pandoc-live is a little utility can be used to watch a Pandoc document for changes, and display the rendering in real-time in a web browser.
- docker-pandoc - use pandoc on hosts without haskel installed (via docker). Brings a inotify based watch tool for nearly live generation of output documents.
- Writage, Markdown plugin for Microsoft Word, is integrated with Pandoc.
Web Services to Process Files by Pandoc
- Pandoc online
- Pandoc as a service: Serving on localhost. (See also: WaybackMachine)
- panzer, adds the concept of 'styles' to pandoc. Styles control templates, metadata settings, pandoc command line options, and instructions to run filters and pre/postprocessors in a simple, reusable, and recombinable way.
- kokoi, a configurable markup file watcher, previewer, and converter that uses Pandoc as the default markup processing engine. kokoi watches for changes on the markup files in the directory kokoi is started, and if they change, automatically reprocesses and previews them directly in the browser.
- pdc is a command line wrapper for pandoc which makes it possible to completely control the conversion process from the first YAML meta block in the input document(s), including multiple output formats at the same time, templates, pre- and post-processors, etc.
- Pandocomatic, allows you to configure flexible YAML templates that control Pandoc settings, filters, metadata and pre/postprocessing. Applied to a directory, pandocomatic can act as a static site generator.
- Pandoc Build Task, a small MSBuild target to transform files with Pandoc. Provided as a Nuget package.
- pandoc-schemata, providing JSON Schema files for Pandoc JSON.
- pandocket, 'A python script that looks for special lines in a markdown file and uses those lines to convert, clean up, and insert content from URLs into the file for processing by pandoc'
- Mighty Make, a building system and an attempt to standardize the folder structure tailored to large pandoc projects, like thesis or large reports.
- fish-completion-pandoc, a pandoc completion script for use with the fish shell.
ickc/pancritic: using CriticMarkup with pandoc: pancritic parses CriticMarkup in pandoc as a wrapper or preprocessor. It can accept or reject or show the diff. in HTML/LaTeX-based outputs.
Using GPP as a preprocessor to get TeX-like macro features in Markdown.
pandoc-gpp by David Loureiro is a wrapper around pandoc and gpp in order to provide some macros for extra markup not available in markdown and its extensions.
PP - A generic Preprocessor (with Pandoc in mind) lets you embed the following diagrams in Markdown code blocks:
- Graphviz (needs to be installed separately)
- PlantUML (embedded in pp at compile time)
- Ditaa (embedded in pp at compile time)
- Asymptote and R figures
and offers many powerful features to expand pandoc power:
- Perl module Pod::Simple::Pandoc parses Plain Old Documentation (POD) markup format to Pandoc data model.
Doc processing tools using Pandoc
Rippledoc processes .md files into html. It ripples down from the current directory through nested subdirectories processing md files as it goes. It also generates tables of contents and navigation links, stitching together the documents into an easily-navigable whole.
SPAB a very simple windows GUI that uses Pandoc and a couple other open source tools to produce a .mobi, .epub, .doc, and .pdf ready for the most popular self-publishing services. (See also: WaybackMachine; How to Self Publish a Book.)
Pandoc Droplets and Services is a collection of simple and easily customizable Automator drag-and-drop applets and service menu items that use pandoc to produce pdf, docx, odt, and dzslides output on OS X.
Markdown menus, by Luke Maciak, provides contextual menus on Windows for creating PDFs and Word documents from markdown files. Double-click on the reg file to install.
PandocMarkdownTools is a small collection of scripts that creates a simple menu structure for conversion of Markdown docs using Pandoc. There are also scripts to simplify creation of Pandoc tables in Markdown and to automate replacement of document markers with the table text.
tpl4md by David Loureiro provides markdown templates for widely used documents such as simple pdf documents, complex pdf documents, letters, invoices, orders, or even slides. The goal is to be able to focus on the content that will be written in markdown. The remaining elements are handle by pandoc, latex etc.
pandoc-watch by David Loureiro is a simple watcher that call the pandoc command with the provided arguments when a file/folder modification is detected.
Uberdoc by Stephan Brosinski is a wrapper script for Pandoc which provides a build system to turn a number of markdown files (chapters) into large documents.
Xmindoc is a wrapper script for Pandoc which converts XMind mindmaps to any documents that are available in Pandoc.
Octavo is a wrapper script for Pandoc that helps to render multiple versions of the same markdown file, FTP them to a server, and insert text into the document that refers to these other versions in plain English. It supports special markdown to produce highlight boxes and other features, comes with its own templates (in Tufte style, normal PDF, Word, html, etc.), and can produce spoken audio versions.
PanDiff produces prose diffs for any document format supported by Pandoc, and can output Markdown with CriticMarkup, HTML, PDF, and Word docx with Track Changes
Using pandoc with ConTeXt
filter module by adityam, which allows you to use
\stopmarkdowndirectly in ConTeXt.
- an even simpler route from markdown to PDF, via ConTeXt.
Tools for Websites
- WordPress EasyFilter, by Yang Zhang, makes it easy to use pandoc with WordPress blogs.
- gitit, a pandoc-based wiki that stores pages in a git (or darcs or mercurial) repository.
- ikiwiki-pandoc, a feature-rich pandoc plugin for ikiwiki. Supports most features of pandoc relevant for a wiki, including almost all textual input formats, several math handling options, as well as citation/bibliography processing via pandoc-citeproc. It also supports several export formats, including pdf, docx, odt, beamer and revealjs. (Ikiwiki-pandoc was originally a fork of the currently unmaintained pandoc-iki).
Static website generators
- yst: create static websites from YAML data and string templates, written in Haskell.
- Hakyll: a static website compiler library in Haskell.
- Website: a bash shell script by Caleb McDaniel to generate a site using pandoc.
- Pandocomatic RubyGem. Can also be used to automate the use of pandoc in a more general way.
- pdsite: single shell script with no dependencies, runs on Unix-like systems.
gh-themes-magick: publish your GitHub project’s single page website from
/docs/folder using GitHub themes, and let pandoc scripts update its contents to mirror the project’s
Serving markdown files with apache
Pandoc wrappers and interfaces
Integration with Reference Managers
- BibDesk Export Templates: drag and drop pandoc-style citations from BibDesk into your document; use pandoc to export formatted reference lists from BibDesk.
- zotxt, allowing direct usage of a Zotero library (with zotxt-emacs for completion in emacs)
- Zotero Integration Extension: If you miss a Word like workflow working with Zotero where you can just search your Zotero library and insert citations wherever you want, then this extension provides such functionality in Brackets for your markdown documents.
- Applets for Zotero and Scrivener integration using Better BibTeX plugin's new Cite as you Write feature. Use in conjunction with this workflow for integrating Scrivner, Pandoc, Zotero and Marked 2
Citation Style Language (CSL) with pandoc
- Testing and Using CSL Style Files with Pandoc -- a GitHub repository with a shell script, a Markdown file and usage instructions enabling you to create visual representations of the effects that any one of the more than 1200 available Citation Style Language (CSL) files may have on your output documents.
Other Wiki Pages
See Pandoc Filters
Templates: Illustrative Pandoc Templates
- This wiki is developing a collection of User Contributed Templates for purposes of illustration; contribute your own, or if you keep pandoc templates under revision control, link them here.
Examples of uses of pandoc
- Using pandoc for IETF RFC creation, courtesy of Miek Gieben
- Preserving old books by rewriting them in markdown, one example of several etexts at Project Gutenberg originally transcribed in markdown