Pandoc

https://pandoc.org/
Admin
Pandoc is a universal document converter that transforms files between numerous markup formats...
Tokens:681,374
Snippets:5,860
Trust Score:9.5
Update:1 month ago
Show doc for...
Tokens:
Raw
### Quick stack method: install pandoc with stack

Source: https://pandoc.org/installing.html

Requires stack >= 1.7.0. stack setup downloads the GHC compiler if needed, and stack install puts the executable in ~/.local/bin, which should be added to PATH.

```shell
stack setup
stack install pandoc-cli
```

--------------------------------

### Install Pandoc with Homebrew

Source: https://pandoc.org/installing.html

Install Pandoc using the Homebrew package manager.

```bash
brew install pandoc

```

--------------------------------

### Install Pandoc for all users on Windows

Source: https://pandoc.org/faqs.html

Run the msiexec command as administrator to perform a system-wide installation.

```bash
msiexec /i pandoc-VERSION.msi ALLUSERS=1
```

--------------------------------

### Paragraph starting with initials not treated as list item

Source: https://pandoc.org/demo/example33/8.7-lists.html

Shows an example of a normal paragraph starting with initials that is not treated as a list item.

```markdown
B. Russell won a Nobel Prize (but not for "On Denoting").

```

--------------------------------

### Quick cabal method: verify installation with pandoc --help

Source: https://pandoc.org/installing.html

Step 4 of the quick cabal method. Verifies the pandoc executable is installed and working.

```shell
pandoc --help
```

--------------------------------

### MultiMarkdown subscript and superscript examples

Source: https://pandoc.org/MANUAL.html

Examples of MultiMarkdown-style subscripts and superscripts parsed by the short_subsuperscripts extension. Superscripts start with '^' and subscripts with '~'.

```markdown
x^2 = 4
```

```markdown
Oxygen is O~2.
```

--------------------------------

### Run tests with stack

Source: https://pandoc.org/CONTRIBUTING.html

Commands to set up the environment and execute the test suite using stack.

```bash
stack setup
stack test
```

--------------------------------

### Grid table example

Source: https://pandoc.org/MANUAL.html

Starts a grid table example. This code block is incomplete; the full grid table syntax is not fully displayed on this page.

```markdown
: Sample grid table.
```

--------------------------------

### Quick cabal method: install pandoc-cli with cabal

Source: https://pandoc.org/installing.html

Installs the released version of pandoc, downloaded from HackageDB. The executable is symlinked in $HOME/.cabal/bin on Linux/Unix/macOS or %APPDATA%\cabal\bin on Windows. Use --installdir to specify a custom directory and --install-method=copy to copy instead of symlink.

```shell
cabal install pandoc-cli
```

--------------------------------

### Repeating a numbered example by re-using its label

Source: https://pandoc.org/demo/example33/8.7-lists.html

Demonstrates repeating an earlier numbered example by re-using its label. This works reliably only if the repeated item is in a list by itself, because each numbered example list is numbered continuously from its starting number.

```markdown
(@foo) Sample sentence.

Intervening text...

This theory can explain the case we saw earlier (repeated):

(@foo) Sample sentence.

```

--------------------------------

### startnum: numbered list with custom start and marker

Source: https://pandoc.org/demo/MANUAL.txt

Pandoc preserves the list marker type and starting number when possible. This example shows a numbered list starting at 9 with a single parenthesis and a sublist using lowercase roman numerals.

```markdown
     9)  Ninth
    10)  Tenth
    11)  Eleventh
           i. subone
          ii. subtwo
         iii. subthree
```

--------------------------------

### Example list with label and continuation

Source: https://pandoc.org/demo/example22.wiki

Shows how to create an example list item with a label. Continuation paragraphs must be indented four spaces.

```markdown
(@good) illustrates, ...
```

--------------------------------

### Resetting example list counter with explicit number

Source: https://pandoc.org/demo/example33/8.7-lists.html

Shows how to reset the example list counter at the beginning of a chapter by specifying a starting number. The number only has an effect if placed on the first of several consecutive items.

```markdown
(1@foo) This item will be numbered 1, and subsequent example
    list items will be numbered 2, 3, etc.

```

--------------------------------

### Parenthesized letter interpreted as list item

Source: https://pandoc.org/demo/example2.html

Example that will be interpreted as a list item because it starts with a parenthesized letter.

```markdown
(C) 2007 Joe Smith
```

--------------------------------

### Install Pandoc to a custom directory on Windows

Source: https://pandoc.org/faqs.html

Use the APPLICATIONFOLDER parameter to specify a custom installation path.

```bash
msiexec /i pandoc-1.11.1.msi ALLUSERS=1 APPLICATIONFOLDER="C:\Pandoc"
```

--------------------------------

### blank_before_header: accidental # at line start

Source: https://pandoc.org/demo/example33/8.3-headings.html

This example shows why pandoc requires a blank line before a heading: a hash at the start of a line can occur accidentally, as in this ice cream list. Without the blank line, the line is not treated as a heading.

```markdown
I like several of their flavors of ice cream:
#22, for example, and #5.
```

--------------------------------

### Pipes with Parameters

Source: https://pandoc.org/demo/example2.html

Example of using pipes that accept parameters, such as left and right alignment with borders.

```text
|----------------------|------------|
$for(employee)$
$it.name.first/uppercase/left 20 "| "$$it.name.salary/right 10 " | " " |"$
$endfor$
|----------------------|------------|
```

--------------------------------

### mmd_title_block: MultiMarkdown title block example

Source: https://pandoc.org/demo/example33/8.21-non-default-extensions.html

Example of a MultiMarkdown title block enabled by the mmd_title_block extension. The block starts with 'Title:', 'Author:', 'Date:', and 'Comment:' fields. Note that if pandoc_title_block or yaml_metadata_block is enabled, it takes precedence over mmd_title_block.

```markdown
Title:   My title
Author:  John Doe
Date:    September 1, 2008
Comment: This is a sample mmd title block, with
         a field spanning multiple lines.
```

--------------------------------

### Set resource path with --resource-path

Source: https://pandoc.org/demo/example5.text

Specifies additional directories for images and other resources using a colon-separated list. The example sets the path to '.' and 'foo'.

```shell
--resource-path .:foo
```

--------------------------------

### Generated Vim help file header

Source: https://pandoc.org/demo/example33/14-vimdoc.html

Example output of a Vim help file generated with the required metadata, showing the header and footer.

```vim
*definition-lists.txt*  A short description

                            Title by Author


                                 Type |gO| to see the table of contents.

[...]

 vim:tw=72:sw=4:ts=4:ft=help:norl:et:

```

--------------------------------

### HTML comment and fenced code containing heading-like lines

Source: https://pandoc.org/filters.html

Example lines that start with ## or ### but appear inside an HTML comment and a delimited code block; these should not be modified.

```markdown
<!--
## This is just a comment
-->

~~~~
### A third level heading in standard markdown
~~~~
```

--------------------------------

### Multiple lists with different marker types

Source: https://pandoc.org/demo/example33/8.7-lists.html

Pandoc starts a new list each time a different type of list marker is used. This example creates three separate lists.

```markdown
(2) Two
(5) Three
1.  Four
*   Five
```

--------------------------------

### Nesting example output

Source: https://pandoc.org/demo/example33/6.1-template-syntax.html

Example output showing how multiple lines of `item.description` are indented to align with the first line.

```text
00123  A fine bottle of 18-year old
       Oban whiskey. ($148)
```

--------------------------------

### Simple table with caption

Source: https://pandoc.org/demo/example33/8.9-tables.html

Example of a simple table with a caption. The header and rows must each fit on one line, and the table must end with a blank line. The caption starts with 'Table:' and can appear before or after the table.

```markdown
  Right     Left     Center     Default
-------     ------ ----------   -------
     12     12        12            12
    123     123       123          123
      1     1          1             1

Table:  Demonstration of simple table syntax.
```

--------------------------------

### Convert from markdown to PDF with xelatex

Source: https://pandoc.org/demos.html

Converts MANUAL.txt to PDF (example13.pdf) using the xelatex PDF engine.

```shell
pandoc MANUAL.txt --pdf-engine=xelatex -o example13.pdf
```
Tokens:
Raw