Introduction

If you need to render a format not already handled by pandoc, or you want to change how pandoc renders a format, you can create a custom writer using the Lua language. Pandoc has a built-in Lua interpreter, so you needn’t install any additional software to do this.

A custom writer is a Lua file that defines how to render the document. Two styles of custom writers are supported: classic custom writers must define rendering functions for each AST element. New style writers, available since pandoc 2.17.2, must define just a single function Writer, which gets passed the document and writer options, and then does all rendering.

Classic style

A writer using the classic style defines rendering functions for each element of the pandoc AST.

For example,

function Para(s)
  return "<paragraph>" .. s .. "</paragraph>"
end

The best way to go about creating a classic custom writer is to modify the example that comes with pandoc. To get the example, you can do

pandoc --print-default-data-file sample.lua > sample.lua

[…] (link to full page)

Introduction

If you need to parse a format not already handled by pandoc, you can create a custom reader using the Lua language. Pandoc has a built-in Lua interpreter, so you needn’t install any additional software to do this.

A custom reader is a Lua file that defines a function called Reader, which takes two arguments:

• the raw input to be parsed, as a list of sources
• optionally, a table of reader options, e.g. { columns = 62, standalone = true }.

The Reader function should return a Pandoc AST. This can be created using functions in the pandoc module, which is automatically in scope. (Indeed, all of the utility functions that are available for Lua filters are available in custom readers, too.)

Each source item corresponds to a file or stream passed to pandoc containing its text and name. E.g., if a single file input.txt is passed to pandoc, then the list of sources will contain just a single element s, where s.name == 'input.txt' and s.text contains the file contents as a string.

[…] (link to full page)

Introduction

Pandoc has long supported filters, which allow the pandoc abstract syntax tree (AST) to be manipulated between the parsing and the writing phase. Traditional pandoc filters accept a JSON representation of the pandoc AST and produce an altered JSON representation of the AST. They may be written in any programming language, and invoked from pandoc using the --filter option.

Although traditional filters are very flexible, they have a couple of disadvantages. First, there is some overhead in writing JSON to stdout and reading it from stdin (twice, once on each side of the filter). Second, whether a filter will work will depend on details of the user’s environment. A filter may require an interpreter for a certain programming language to be available, as well as a library for manipulating the pandoc AST in JSON form. One cannot simply provide a filter that can be used by anyone who has a certain version of the pandoc executable.

Starting with version 2.0, pandoc makes it possible to write filters in Lua without any external dependencies at all. A Lua interpreter (version 5.3) and a Lua library for creating pandoc filters is built into the pandoc executable. Pandoc data types are marshaled to Lua directly, avoiding the overhead of writing JSON to stdout and reading it from stdin.

[…] (link to full page)

Synopsis

pandoc [options] [input-file]…

Description

Pandoc is a Haskell library for converting from one markup format to another, and a command-line tool that uses this library.

Pandoc can convert between numerous markup and word processing formats, including, but not limited to, various flavors of Markdown, HTML, LaTeX and Word docx. For the full lists of input and output formats, see the --from and --to options below. Pandoc can also produce PDF output: see creating a PDF, below.

Pandoc’s enhanced version of Markdown includes syntax for tables, definition lists, metadata blocks, footnotes, citations, math, and much more. See below under Pandoc’s Markdown.

[…] (link to full page)

Themes & Overlays

Composer (Templates)

• Theme: site.custom, Overlay: null
• Theme: site.custom-solar, Overlay: null

Bootswatch

• Theme: site.light, Overlay: light
• Theme: site.dark, Overlay: dark
• Theme: site.solar-light, Overlay: dark
  • (same as site.solar-dark)
• Theme: site.solar-dark, Overlay: dark
• Theme: site.css_alt, Overlay: dark
• Theme: site.css_alt, Overlay: null

Water.css

• Theme: html.light, Overlay: light
• Theme: html.dark, Overlay: dark
• Theme: html.css_alt, Overlay: dark
  • (automatic prefers-color-scheme color selection)
• Theme: html.css_alt, Overlay: null (default: html)
  • (automatic prefers-color-scheme color selection)
• Theme: html.solar-light, Overlay: dark
• Theme: html.solar-dark, Overlay: dark
• Theme: html.solar-css_alt, Overlay: dark (default: site)
  • (automatic prefers-color-scheme color selection)
• Theme: html.solar-css_alt, Overlay: null
  • (automatic prefers-color-scheme color selection)

[…] (link to full page)

Page Layout

Elements

Introduction

#WORK # introduction

Example Pages

The entire list of pages in this test site can be found in the main sitemap. To understand how the site is configured, and to see demonstrations of all the features, visit the following pages. This list can be found in the PAGES menu on the top bar throughout the site.

Composer README

Created with c_site, and configured to produce a navigable reference document.

Introduction

Main page, with information about this test site and how to use it.

Default Site

An empty configuration, to demonstrate a simple page with no layout or elements.

Configured Site

All settings changed, showcasing the full flexibility of layout and behavior.

Pandoc Markdown

A Pandoc markdown file, without any Composer embedded elements.

Bootstrap Default

A markdown file with default Bootstrap colors instead of themes and overlays.

[…] (link to full page)

#WORK

#WORK

<!-- composer >> metainfo -->

Configuration Settings

[…] (link to full page)