git.iko.soy/typeable/pandoc

on 9029206 help sign in

fromb8e0b46

swap

to0 ahead, 4445 behind

compare

.circleci/config.ymldeleted−72

@@ -1,72 +0,0 @@

1−version: "2.1"

2−jobs:

3− build:

4− macos:

5− xcode: 11.1.0

6− environment:

7− HOMEBREW_NO_AUTO_UPDATE: 1

8− steps:

9− - checkout

10− - restore_cache:

11− # See https://circleci.com/docs/2.0/caching/

12− name: Restore Cached Dependencies

13− keys:

14− - stack-dependencies-{{ checksum "stack.yaml" }}

15− - run:

16− name: Install stack

17− command: stack --version || (curl -sSL https://get.haskellstack.org/ | sh -s - -f)

18− - run:

19− name: Resolve/Update Dependencies

20− command: stack --no-terminal setup

21− - run:

22− name: Run tests

23− command: stack --no-terminal test

24− - run:

25− name: Install executable

26− command: stack --no-terminal install

27− - run:

28− name: Create artifacts

29− command: |

30− export VERSION=$(grep '^[Vv]ersion:' pandoc.cabal | awk '{print $$2;}')

31− export ARTIFACTS=macos-release-candidate

32− export RESOURCES=${ARTIFACTS}/Resources

33− export ROOT=${ARTIFACTS}/pandoc

34− export DEST=${ROOT}/usr/local

35− export ME=$(whoami)

36− export BASE=pandoc-$VERSION

37− mkdir -p ${ARTIFACTS}

38− mkdir -p ${RESOURCES}

39− mkdir -p ${DEST}/bin

40− mkdir -p ${DEST}/share/man/man1

41− cp ~/.local/bin/pandoc ${DEST}/bin/

42− strip ${DEST}/bin/pandoc

43− cp man/pandoc.1 ${DEST}/share/man/man1/pandoc.1

44− ~/.local/bin/pandoc -s COPYING.md -Vpagetitle=License -o ${RESOURCES}/license.html

45− chown -R $ME:staff ${ROOT}

46− sed -e "s/PANDOCVERSION/${VERSION}/" macos/distribution.xml.in > ${ARTIFACTS}/distribution.xml

47− cp macos/Makefile ${ARTIFACTS}/

48− echo ${VERSION} > ${ARTIFACTS}/version.txt

49− zip -r macos-release-candidate.zip ${ARTIFACTS}

50−

51− - save_cache:

52− name: Cache Dependencies

53− key: stack-dependencies-{{ checksum "stack.yaml" }}

54− paths:

55− - "/root/.stack"

56− - ".stack-work"

57− - "/usr/local/bin/stack"

58−

59− - store_artifacts:

60− # https://circleci.com/docs/2.0/artifacts/

61− path: macos-release-candidate.zip

62− destination: macos-release-candidate.zip

63−

64−workflows:

65− version: 2

66− release:

67− jobs:

68− - build:

69− filters:

70− branches:

71− only:

72− - /rc\/.*/

.editorconfig−8

@@ -8,14 +8,6 @@ indent_size = 2

88insert_final_newline = true

99trim_trailing_whitespace = true

1010

11−[*.{zip,docx}]

12−charset =

13−end_of_line =

14−indent_style =

15−indent_size =

16−insert_final_newline =

17−trim_trailing_whitespace =

18−

1911[*.{markdown,md}]

2012trim_trailing_whitespace = false

2113

.gitattributesdeleted−1

@@ -1 +0,0 @@

1−test/fb2/reader/* -text

.github/FUNDING.ymldeleted−1

@@ -1 +0,0 @@

1−github: [jgm,tarleb]

.github/ISSUE_TEMPLATEnew file+11

@@ -0,0 +1,11 @@

1+Asking a question?

2+Please use the pandoc-discuss mailing list instead:

3+https://groups.google.com/forum/#!forum/pandoc-discuss

4+This tracker is for bug reports and enhancement requests.

5+

6+Reporting a bug?

7+Please include your pandoc version and an example that allows us

8+to reproduce the problem (complete input, exact command line

9+used, expected and actual output). The smaller the example, the

10+better.

11+

.github/ISSUE_TEMPLATE/bug_report.mddeleted−25

@@ -1,25 +0,0 @@

1−---

2−name: Bug report

3−about: Create a report to help us improve

4−title: ''

5−labels: 'bug'

6−assignees: ''

7−

8−---

9−

10−<!--

11−Thank you for reporting an issue! Before you continue, please make sure that you have

12−

13−- searched the issue tracker for similar issues (including closed issues): https://github.com/jgm/pandoc/issues

14−- searched the pandoc-discuss mailing list for solutions: https://groups.google.com/forum/#!forum/pandoc-discuss

15−- reproduced your issue on the latest release of pandoc, or on https://pandoc.org/try

16−

17−Note that this bug tracker is for reporting bugs, not asking questions. For questions, use the pandoc-discuss mailing list.

18−-->

19−

20−**Explain the problem.**

21−Include the exact command line you used and all inputs necessary to reproduce the issue. Please create as minimal an example as possible, to help the maintainers isolate the problem. Explain the output you received and how it differs from what you expected.

22−

23−**Pandoc version?**

24−What version of pandoc are you using, on what OS?

25−

.github/ISSUE_TEMPLATE/config.ymldeleted−9

@@ -1,9 +0,0 @@

1−blank_issues_enabled: false

2−contact_links:

3− - name: Ask a question

4− url: https://groups.google.com/forum/#!forum/pandoc-discuss

5− about: "Discussion forum for pandoc (may be used as an email list)"

6− - name: Contributing Guidelines

7− url: https://pandoc.org/CONTRIBUTING.html

8− about: "Guidelines for submitting bug reports and code improvements"

9−

.github/ISSUE_TEMPLATE/feature_request.mddeleted−21

@@ -1,21 +0,0 @@

1−---

2−name: Feature request

3−about: Suggest an idea for this project

4−title: ''

5−labels: 'enhancement'

6−assignees: ''

7−

8−---

9−

10−<!--

11−Thank you for suggesting a feature! Before you continue, please make sure that you have

12−

13−- read the contributing guidelines: https://pandoc.org/CONTRIBUTING.html

14−- searched the issue tracker for similar issues (including closed issues): https://github.com/jgm/pandoc/issues

15−- searched the pandoc-discuss mailing list for relevant discussions: https://groups.google.com/forum/#!forum/pandoc-discuss

16−-->

17−

18−**Describe your proposed improvement and the problem it solves.**

19−

20−**Describe alternatives you've considered.**

21−

.github/workflows/ci.ymldeleted−275

@@ -1,275 +0,0 @@

1−name: CI tests

2−

3−on:

4− push:

5− branches:

6− - '*'

7− - '!rc/*'

8− paths-ignore:

9− - 'doc/**'

10− - 'MANUAL.txt'

11− - '*.md'

12− - 'RELEASE_CHECKLIST'

13− - 'BUGS'

14− - 'changelog'

15− - 'README.template'

16− - 'appveyor.yml'

17− - 'tools/**'

18− - 'linux/**'

19− - 'macos/**'

20− - 'windows/**'

21− - 'man/**'

22− pull_request:

23− paths-ignore:

24− - 'doc/**'

25− - 'MANUAL.txt'

26− - '*.md'

27− - 'RELEASE_CHECKLIST'

28− - 'BUGS'

29− - 'changelog'

30− - 'README.template'

31− - 'appveyor.yml'

32− - 'tools/**'

33− - 'linux/**'

34− - 'macos/**'

35− - 'windows/**'

36− - 'man/**'

37−

38−jobs:

39− linux:

40−

41− runs-on: ubuntu-18.04

42− strategy:

43− fail-fast: true

44− matrix:

45− versions:

46− - ghc: '8.0.2'

47− cabal: '2.4'

48− prefix: 'v2-'

49− cabalopts: ''

50− testopts: ''

51− - ghc: '8.2.2'

52− cabal: '2.4'

53− prefix: 'v2-'

54− cabalopts: ''

55− testopts: ''

56− - ghc: '8.4.4'

57− cabal: '2.4'

58− prefix: 'v2-'

59− cabalopts: '-f-embed_data_files'

60− testopts: ''

61− - ghc: '8.6.5'

62− cabal: '3.2'

63− prefix: ''

64− cabalopts: ''

65− testopts: '--test-option=--hide-successes'

66− - ghc: '8.8.4'

67− cabal: '3.2'

68− prefix: ''

69− cabalopts: ''

70− testopts: '--test-option=--hide-successes'

71− - ghc: '8.10.4'

72− cabal: '3.2'

73− prefix: ''

74− cabalopts: '-ftrypandoc'

75− testopts: '--test-option=--hide-successes'

76− - ghc: '9.0.1'

77− cabal: '3.4'

78− prefix: ''

79− cabalopts: ''

80− testopts: '--test-option=--hide-successes'

81− steps:

82− - uses: actions/checkout@v2

83−

84− # needed by memory

85− - name: Install numa

86− run: sudo apt-get install libnuma-dev

87−

88− # need to install older cabal/ghc versions from ppa repository

89−

90− - name: Install recent cabal/ghc

91− uses: haskell/actions/setup@v1

92− with:

93− ghc-version: ${{ matrix.versions.ghc }}

94− cabal-version: ${{ matrix.versions.cabal }}

95−

96− # declare/restore cached things

97− # caching doesn't work for scheduled runs yet

98− # https://github.com/actions/cache/issues/63

99−

100− - name: Cache cabal global package db

101− id: cabal-global

102− uses: actions/cache@v2

103− with:

104− path: |

105− ~/.cabal

106− key: ${{ runner.os }}-${{ matrix.versions.ghc }}-${{ matrix.versions.cabal }}-cabal-global-${{ hashFiles('cabal.project') }}

107−

108− - name: Cache cabal work

109− id: cabal-local

110− uses: actions/cache@v2

111− with:

112− path: |

113− dist-newstyle

114− key: ${{ runner.os }}-${{ matrix.versions.ghc }}-${{ matrix.versions.cabal }}-cabal-local

115−

116− - name: Install dependencies

117− run: |

118− cabal ${{ matrix.versions.prefix }}update

119− cabal ${{ matrix.versions.prefix }}build ${{ matrix.versions.cabalopts }} --dependencies-only --enable-tests --disable-optimization

120−

121− - name: Build and test

122− run: |

123− cabal ${{ matrix.versions.prefix }}build ${{ matrix.versions.cabalopts }} --enable-tests --disable-optimization 2>&1 | tee build.log

124− # fail if warnings in local build

125− ! grep -q ": *[Ww]arning:" build.log || exit 1

126− cabal ${{ matrix.versions.prefix }}test ${{ matrix.versions.cabalopts }} --disable-optimization ${{ matrix.versions.testopts }}

127−

128− windows:

129−

130− runs-on: windows-2019

131−

132− steps:

133− - uses: actions/checkout@v2

134−

135− # We should have ghc 8.10, cabal, stack pre-installed

136− # - uses: haskell/actions/setup@v1

137− # with:

138− # enable-stack: true

139− # stack-version: 'latest'

140−

141− # declare/restore cached things

142− # caching doesn't work for scheduled runs yet

143− # https://github.com/actions/cache/issues/63

144−

145− - name: Cache stack global package db

146− id: stack-global-package-db

147− uses: actions/cache@v2

148− with:

149− path: |

150− C:\Users\runneradmin\AppData\Roaming\stack\

151− key: ${{ runner.os }}-appdata-roaming-stack-${{ hashFiles('stack.yaml') }}

152−

153− # stack's local package dbs for the project and each package

154− # - name: Cache .stack-work

155− # uses: actions/cache@v1

156− # with:

157− # path: .stack-work

158− # key: ${{ runner.os }}-stack-work-${{ hashFiles('stack.yaml') }}

159− # restore-keys: ${{ runner.os }}-stack-work

160−

161− - name: Install dependencies

162− run: |

163− stack update

164− stack install happy

165− stack test --dependencies-only --fast

166− - name: Build and test

167− shell: cmd

168− run: |

169− stack test --fast --test-arguments=--hide-successes

170−

171− macos:

172−

173− runs-on: macOS-10.15

174− strategy:

175− fail-fast: true

176− matrix:

177− versions:

178− - ghc: '8.8.4'

179− cabal: '3.2'

180−

181− steps:

182− - uses: actions/checkout@v2

183−

184− - name: Install recent cabal/ghc

185− uses: haskell/actions/setup@v1

186− with:

187− ghc-version: ${{ matrix.versions.ghc }}

188− cabal-version: ${{ matrix.versions.cabal }}

189−

190− # declare/restore cached things

191− # caching doesn't work for scheduled runs yet

192− # https://github.com/actions/cache/issues/63

193−

194− - name: Cache cabal global package db

195− id: cabal-global

196− uses: actions/cache@v2

197− with:

198− path: |

199− ~/.cabal

200− key: ${{ runner.os }}-${{ matrix.versions.ghc }}-${{ matrix.versions.cabal }}-cabal-global-${{ hashFiles('cabal.project') }}

201−

202− - name: Cache cabal work

203− id: cabal-local

204− uses: actions/cache@v2

205− with:

206− path: |

207− dist-newstyle

208− key: ${{ runner.os }}-${{ matrix.versions.ghc }}-${{ matrix.versions.cabal }}-cabal-local

209−

210− - name: Install dependencies

211− run: |

212− cabal v2-update

213− cabal v2-build --dependencies-only --enable-tests --disable-optimization

214− - name: Build and test

215− run: |

216− cabal v2-build --enable-tests --disable-optimization 2>&1 | tee build.log

217− # fail if warnings in local build

218− ! grep -q ": *[Ww]arning:" build.log || exit 1

219− cabal v2-test --disable-optimization

220−

221− benchmark:

222−

223− runs-on: ubuntu-18.04

224− strategy:

225− fail-fast: true

226− matrix:

227− versions:

228− - ghc: '8.8.4'

229− cabal: '3.2'

230− - ghc: '8.10.2'

231− cabal: '3.2'

232− steps:

233− - uses: actions/checkout@v2

234−

235− # need to install older cabal/ghc versions from ppa repository

236−

237− - name: Install recent cabal/ghc

238− uses: haskell/actions/setup@v1

239− with:

240− ghc-version: ${{ matrix.versions.ghc }}

241− cabal-version: ${{ matrix.versions.cabal }}

242−

243− # declare/restore cached things

244− # caching doesn't work for scheduled runs yet

245− # https://github.com/actions/cache/issues/63

246−

247− - name: Cache cabal global package db

248− id: cabal-global

249− uses: actions/cache@v2

250− with:

251− path: |

252− ~/.cabal

253− key: benchmark-${{ runner.os }}-${{ matrix.versions.ghc }}-${{ matrix.versions.cabal }}-cabal-global-${{ hashFiles('cabal.project') }}

254−

255− - name: Cache cabal work

256− id: cabal-local

257− uses: actions/cache@v2

258− with:

259− path: |

260− dist-newstyle

261− key: benchmark-${{ runner.os }}-${{ matrix.versions.ghc }}-${{ matrix.versions.cabal }}-cabal-local

262−

263− - name: Install dependencies

264− run: |

265− v2=$([ "${{ matrix.versions.cabal }}" = "2.2" ] && printf 'new' || printf 'v2')

266− cabal $v2-update

267− cabal $v2-build --dependencies-only --enable-optimization=1 --enable-benchmarks --disable-tests

268−

269− - name: Build and test

270− run: |

271− v2=$([ "${{ matrix.versions.cabal }}" = "2.2" ] && printf 'new' || printf 'v2')

272− cabal $v2-build --enable-optimization=1 --enable-benchmarks --disable-tests 2>&1 | tee build.log

273− # fail if warnings in local build

274− ! grep -q ": *[Ww]arning:" build.log || exit 1

275− cabal $v2-bench --enable-optimization=1 --benchmark-options='--timeout=6 +RTS -T -RTS'

.github/workflows/commit-validation.ymldeleted−38

@@ -1,38 +0,0 @@

1−name: commit-validation

2−on: [ push, pull_request ]

3−

4−jobs:

5− check-commit-msg-length:

6− runs-on: ubuntu-latest

7− steps:

8− - uses: actions/checkout@v1

9− - name: Check commit message length

10− run: |

11− # Get last commit messages

12− if [ "${{github.event_name}}" = "push" ]; then

13− if [ "${{github.event.before}}" = "0000000000000000000000000000000000000000" ]; then

14− # We are on a new branch

15− current="$(echo '${{github.ref}}' | sed 's!^refs/heads!origin!')"

16− readarray -t other < <(git show-ref | awk -F' ' '{ sub(/^refs\/remotes\//,"",$NF); }($NF != "'"$current"'"){print "^" $NF;}')

17− LOG_RANGE=( "$current" "${other[@]}" )

18− unset current other

19− else

20− # We are on existing branch

21− LOG_RANGE=( "${{github.event.before}}.." )

22− fi

23− elif [ "${{github.event_name}}" = "pull_request" ]; then

24− LOG_RANGE=( "origin/${{github.base_ref}}.." )

25− fi

26− if [[ -v LOG_RANGE ]]; then

27− if git log --no-merges --pretty=format:"%s" "${LOG_RANGE[@]}" -- | grep -qE "^[^#].{78}"; then

28− echo -e "Last commit log contains a line with more than 78 characters:\n"

29− git log --no-merges --pretty=format:"%h: %s" "${LOG_RANGE[@]}" -- | grep -E "^[^:]+: [^#].{78}"

30− echo

31− exit 1

32− else

33− echo "Commit log looks good."

34− fi

35− unset LOG_RANGE

36− else

37− echo "Not checking commits on ${{github.event_name}}"

38− fi

.github/workflows/format-validation.ymldeleted−88

@@ -1,88 +0,0 @@

1−name: Format validation

2−

3−on:

4− push:

5− branches:

6− - '*'

7− - '!rc/*'

8− paths:

9− - 'test/writer.jats_articleauthoring'

10− - 'test/writer.jats_publishing'

11− - 'test/writer.jats_archiving'

12− - 'test/tables.jats_archiving'

13− - 'test/tables/nordics.jats_archiving'

14− - 'test/tables/planets.jats_archiving'

15− - 'test/tables/students.jats_archiving'

16− pull_request:

17− branches:

18− - '*'

19− - '!rc/*'

20− paths:

21− - 'test/writer.jats_articleauthoring'

22− - 'test/writer.jats_publishing'

23− - 'test/writer.jats_archiving'

24− - 'test/tables.jats_archiving'

25− - 'test/tables/nordics.jats_archiving'

26− - 'test/tables/planets.jats_archiving'

27− - 'test/tables/students.jats_archiving'

28−

29−jobs:

30− jats:

31− name: JATS

32− runs-on: ubuntu-latest

33− env:

34− VALIDATOR_URL: "https://jats-validator.hubmed.org/dtd/"

35− strategy:

36− fail-fast: false

37− matrix:

38− tagset:

39− - articleauthoring

40− - publishing

41− - archiving

42− steps:

43− - name: Checkout

44− uses: actions/checkout@v2

45−

46− - name: Validate writer output

47− run: |

48− filename=test/writer.jats_${{ matrix.tagset }}

49− printf "Validating file %s\n" "$filename"

50− json="$(curl --form "xml=@${filename}" --silent "$VALIDATOR_URL")"

51− err_count="$(printf '%s' "$json" | jq '.errors | length')"

52− if [ "$err_count" -eq 0 ]; then

53− printf "File was validated successfully.\n"

54− exit 0

55− else

56− printf "Validator report:\n%s" "$json"

57− exit 1

58− fi

59−

60− - name: Validate tables

61− # Archiving has the simplest template, so we only check with that.

62− if: matrix.tagset == 'archiving'

63− run: |

64− tmpl="$(cat <<EOF

65− <?xml version="1.0" encoding="utf-8" ?>

66− <!DOCTYPE article PUBLIC "-//NLM//DTD JATS (Z39.96) Journal Archiving and Interchange DTD v1.2 20190208//EN"

67− "JATS-archivearticle1.dtd">

68− <article xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:xlink="http://www.w3.org/1999/xlink" dtd-version="1.2" article-type="other">

69− <front><article-meta></article-meta></front>

70− <body>%s</body></article>

71− EOF

72− )"

73− jats_file="$(mktemp jats-tables.XXXXX)"

74− exit_code=0

75− for f in tables tables/nordics tables/planets tables/students; do

76− filename=test/$f.jats_archiving

77− printf "Validating %s...\n" "$filename"

78− printf "$tmpl" "$(cat $filename)" > "$jats_file"

79− json="$(curl --form "xml=@${jats_file}" --silent "$VALIDATOR_URL")"

80− err_count="$(printf "%s" "$json" | jq '.errors | length')"

81− if [ "$err_count" -eq 0 ]; then

82− printf "Table output is valid when used as body content.\n"

83− else

84− printf "Validator report:\n%s" "$json"

85− exit_code=1

86− fi

87− done

88− exit "$exit_code"

.github/workflows/lint.ymldeleted−33

@@ -1,33 +0,0 @@

1−name: Lint

2−

3−# Trigger the workflow on push or pull request, but only for the

4−# master branch

5−on:

6− pull_request:

7− branch: [master]

8− push:

9− branch: [master]

10− paths-ignore:

11− - LICENSE

12− - README.md

13− - CHANGELOG.md

14− - stack.yaml

15− - .travis.yml

16−

17−jobs:

18− lint:

19− name: Lint

20− runs-on: ubuntu-latest

21− env:

22− hlint_script: https://raw.github.com/ndmitchell/hlint/master/misc/run.sh

23−

24− steps:

25− - name: Checkout

26− uses: actions/checkout@v2

27−

28− - name: Check cabal file for missing test files

29− run: make check-cabal

30−

31− - name: Download and run hlint

32− run: |

33− curl -sSL "${hlint_script}" | sh -s .

.github/workflows/nightly.ymldeleted−91

@@ -1,91 +0,0 @@

1−name: Nightly

2−

3−on:

4− schedule:

5− - cron: '53 7 * * *'

6−

7−jobs:

8− linux:

9−

10− runs-on: ubuntu-18.04

11− steps:

12− - uses: actions/checkout@v2

13−

14− - name: Install recent cabal/ghc

15− uses: haskell/actions/setup@v1

16− with:

17− ghc-version: '8.10.3'

18− cabal-version: '3.2'

19−

20− - name: Install dependencies

21− run: |

22− ghc --version

23− cabal --version

24− cabal v2-update

25− cabal v2-build --dependencies-only

26− - name: Build

27− run: |

28− cabal v2-install

29− strip $HOME/.cabal/bin/pandoc

30− - name: Install artifact

31− run: |

32− export ARTIFACTS=nightly-linux/pandoc-nightly-linux-$(date +%Y-%m-%d)

33− mkdir -p ${ARTIFACTS}

34− cp $HOME/.cabal/bin/pandoc ${ARTIFACTS}/

35− cp COPYRIGHT ${ARTIFACTS}/

36− echo "Built from ${GITHUB_SHA}" > ${ARTIFACTS}/README.nightly.txt

37− - uses: actions/upload-artifact@master

38− with:

39− name: nightly-linux

40− path: nightly-linux

41−

42− windows:

43−

44− runs-on: windows-2019

45−

46− steps:

47− - uses: actions/checkout@v2

48− - name: Install dependencies

49− run: |

50− stack update

51− stack build --dependencies-only pandoc

52− - name: Build artifacts

53− shell: cmd

54− run: |

55− for /f %%a in ('powershell -Command "Get-Date -format yyyy-MM-dd"') do set THEDATE=%%a

56− set ARTIFACTS=%CD%\nightly-windows\pandoc-nightly-windows-%THEDATE%

57− mkdir %ARTIFACTS%

58− stack build pandoc

59− forfiles /P .\.stack-work\install /M pandoc*.exe /S /C "cmd /C copy @path %%ARTIFACTS%%"

60− copy COPYRIGHT %ARTIFACTS%

61− ren %ARTIFACTS%\COPYRIGHT COPYRIGHT.txt

62− echo Built from %GITHUB_SHA% > %ARTIFACTS%\README.nightly.txt

63− - uses: actions/upload-artifact@master

64− with:

65− name: nightly-windows

66− path: nightly-windows

67−

68− macos:

69−

70− runs-on: macOS-10.15

71−

72− steps:

73− - uses: actions/checkout@v2

74− - name: Install dependencies

75− run: |

76− stack update

77− stack build --dependencies-only pandoc

78− - name: Build artifacts

79− run: |

80− export ARTIFACTS=nightly-macos/pandoc-nightly-macos-$(date +%Y-%m-%d)

81− mkdir -p ${ARTIFACTS}

82− stack build pandoc

83− for f in $(find .stack-work/install -name 'pandoc*' -perm +001 -type f); do cp $f ${ARTIFACTS}/; done

84− mv ${ARTIFACTS}/pandoc ${ARTIFACTS}/pandoc

85− cp COPYRIGHT ${ARTIFACTS}/

86− echo "Built from ${GITHUB_SHA}" > ${ARTIFACTS}/README.nightly.txt

87− - uses: actions/upload-artifact@master

88− with:

89− name: nightly-macos

90− path: nightly-macos

91−

.github/workflows/release-candidate.ymldeleted−83

@@ -1,83 +0,0 @@

1−name: Release candidate

2−

3−on:

4− push:

5− branches:

6− - 'rc/**'

7−

8−jobs:

9− linux:

10−

11− runs-on: ubuntu-18.04

12− steps:

13− - uses: actions/checkout@v1

14− - name: Create linux package

15− run: |

16− make debpkg

17− mkdir linux-release-candidate

18− cp linux/artifacts/*.deb linux-release-candidate/

19− cp linux/artifacts/*.tar.gz linux-release-candidate/

20− - uses: actions/upload-artifact@v2

21− with:

22− name: linux-release-candidate

23− path: linux-release-candidate

24−

25− windows:

26−

27− runs-on: windows-2019

28− strategy:

29− fail-fast: true

30− matrix:

31− versions:

32− - osarch: "windows-x86_64"

33− arch: "x64"

34− stack_opts: "-j1"

35− steps:

36− - uses: actions/checkout@v1

37− - name: Install dependencies

38− run: |

39− stack update

40− stack build ${{ matrix.versions.stack_opts }} --dependencies-only pandoc

41− - name: Create windows package

42− shell: cmd

43− run: |

44− for /f %%a in ('powershell -Command "Get-Date -format yyyy-MM-dd"') do set THEDATE=%%a

45− stack build ${{ matrix.versions.stack_opts }} pandoc

46− for /f "tokens=1-2 delims= " %%a in ('stack exec pandoc -- --version') do (

47− @set VERSION=%%b

48− goto :next

49− )

50− :next

51− if "%VERSION%" == "" (

52− echo Error: could not determine version number.

53− exit /b 1

54− )

55− echo Detected version %VERSION%

56− @set WINDOWS=%CD%\windows

57− @set RELEASE=%WINDOWS%\pandoc-%VERSION%

58− mkdir %RELEASE%

59− forfiles /P .\.stack-work\install /M pandoc.exe /S /C "cmd /C echo @path && echo %%WINDOWS%% && copy @path %%RELEASE%%"

60− stack exec pandoc -- -s --toc MANUAL.txt -o %RELEASE%\MANUAL.html

61− stack exec pandoc -- -s COPYING.md -t rtf -o %RELEASE%\COPYING.rtf

62− copy %RELEASE%\COPYING.rtf %WINDOWS%

63− copy COPYRIGHT %RELEASE%\COPYRIGHT.txt

64− cd windows

65− echo Creating msi...

66− dir

67− @set WIXBIN="c:\Program Files (x86)\WiX Toolset v3.11\bin"

68− @set WORKDIR=%CD%

69− echo Running candle...

70− %WIXBIN%\candle -arch ${{ matrix.versions.arch }} -dVERSION=%VERSION% -dBINPATH=%RELEASE% *.wxs -out wixobj\

71− if %errorlevel% neq 0 exit /b %errorlevel%

72− echo Running light...

73− %WIXBIN%\light -sw1076 -ext WixUIExtension -ext WixUtilExtension -cultures:en-us -loc Pandoc-en-us.wxl -out %WORKDIR%\pandoc-%VERSION%-${{ matrix.versions.osarch }}-UNSIGNED.msi wixobj\*.wixobj

74− 7z a "pandoc-%VERSION%-${{ matrix.versions.osarch }}.zip" pandoc-%VERSION%

75− cd ..

76− mkdir windows-release-candidate

77− copy windows\pandoc-%VERSION%-${{ matrix.versions.osarch }}-UNSIGNED.msi windows-release-candidate

78− copy windows\pandoc-%VERSION%-${{ matrix.versions.osarch }}.zip windows-release-candidate

79− copy windows\Makefile windows-release-candidate

80− - uses: actions/upload-artifact@v2

81− with:

82− name: windows-release-candidate

83− path: windows-release-candidate

.gitignore−10

@@ -1,6 +1,4 @@

11*~

2−.DS_Store

3−*.orig

42deb/.vagrant

53dist/*

64MANUAL.*

@@ -16,10 +14,6 @@ man/man?/*.html

1614*.o

1715*.hi

1816*.pyc

19−.hie/

20−.policeman-evidence/

21−.projectile/

22−.vscode/

2317/COPYING.rtf

2418/COPYRIGHT.txt

2519/cabal-dev/

@@ -29,7 +23,3 @@ windows/*.wixobj

2923data/reference.docx

3024data/reference.odt

3125.stack-work

32−/stack.yaml.lock

33−cabal.project.local

34−/dist-newstyle/

35−pandoc-2*/

.hlint.yaml+54−94

@@ -2,111 +2,71 @@

22# https://github.com/ndmitchell/hlint

33##########################

44

5−# Specify additional command line arguments

6−#

7−- arguments: [--color=auto, --cpp-ansi]

5+# This file contains a template configuration file, which is typically

6+# placed as .hlint.yaml in the root of your project

87

9−# Ignore some builtin hints

10−#

11−- ignore: {name: "Avoid lambda"}

12−- ignore: {name: "Use bimap"}

13−- ignore: {name: "Eta reduce"}

14−- ignore: {name: "Evaluate"}

15−- ignore: {name: "Reduce duplication"} # TODO: could be more fine-grained

16−- ignore: {name: "Use &&&"}

17−- ignore: {name: "Use String"}

18−- ignore: {name: "Use camelCase"}

19−- ignore: {name: "Use fmap"} # specific for GHC 7.8 compat

20−- ignore: {name: "Use isDigit"}

21−

22−- ignore:

23− name: "Monad law, left identity"

24− within: Text.Pandoc.App.OutputSettings

25−

26−- ignore:

27− name: "Move brackets to avoid $"

28− within: Text.Pandoc.Writers.CslJson

29−

30−- ignore:

31− name: "Redundant <$>"

32− within:

33− - Text.Pandoc.Readers.Docx.Parse

34− - Text.Pandoc.Writers.MediaWiki

35− - Text.Pandoc.Writers.OpenDocument

36− - Text.Pandoc.Writers.Powerpoint.Output

37− - Text.Pandoc.Writers.Powerpoint.Presentation

38−

39−- ignore:

40− name: "Redundant return"

41− within: Text.Pandoc.Citeproc.BibTeX

428

43−# With recent hlint this rule has given false positives on TH

44−- ignore:

45− name: "Redundant bracket"

9+# Specify additional command line arguments

10+#

11+- arguments: [--color, --cpp-ansi]

4612

4713

48−- ignore:

49− name: "Use <$>"

50− within:

51− - Text.Pandoc.Readers.LaTeX

52− - Text.Pandoc.Readers.Markdown

14+# Control which extensions/flags/modules/functions can be used

15+#

16+# - extensions:

17+# - default: false # all extension are banned by default

18+# - name: [PatternGuards, ViewPatterns] # only these listed extensions can be used

19+# - {name: CPP, within: CrossPlatform} # CPP can only be used in a given module

20+#

21+# - flags:

22+# - {name: -w, within: []} # -w is allowed nowhere

23+#

24+# - modules:

25+# - {name: [Data.Set, Data.HashSet], as: Set} # if you import Data.Set qualified, it must be as 'Set'

26+# - {name: Control.Arrow, within: []} # Certain modules are banned entirely

27+#

28+# - functions:

29+# - {name: unsafePerformIO, within: []} # unsafePerformIO can only appear in no modules

5330

54−- ignore:

55− name: "Use camelCase"

56− within:

57− - Tests.Writers.Docbook

58− - Tests.Writers.Native

59− - Text.Pandoc.Citeproc

60− - Text.Pandoc.Extensions

61− - Text.Pandoc.Lua.Marshaling.Version

62− - Text.Pandoc.Lua.Module.Pandoc

63− - Text.Pandoc.Lua.Module.Utils

64− - Text.Pandoc.Readers.Odt.ContentReader

65− - Text.Pandoc.Readers.Odt.Namespaces

6631

67−- ignore:

68− name: "Use forM_"

69− within:

70− - Text.Pandoc.Readers.DocBook

32+# Add custom hints for this project

33+#

34+# Will suggest replacing "wibbleMany [myvar]" with "wibbleOne myvar"

35+# - error: {lhs: "wibbleMany [x]", rhs: wibbleOne x}

7136

72−- ignore:

73− name: "Use Just"

74− within:

75− - Text.Pandoc.Citeproc.MetaValue

76− - Text.Pandoc.Readers.Odt.ContentReader

77− - Text.Pandoc.Writers.Roff

7837

79−- ignore:

80− name: "Use list comprehension"

81− within: Text.Pandoc.Citeproc.BibTeX

38+# Turn on hints that are off by default

39+#

40+# Ban "module X(module X) where", to require a real export list

41+# - warn: {name: Use explicit module export list}

42+#

43+# Replace a $ b $ c with a . b $ c

44+# - group: {name: dollar, enabled: true}

45+#

46+# Generalise map to fmap, ++ to <>

47+# - group: {name: generalise, enabled: true}

8248

83−- ignore:

84− name: "Use list literal pattern"

85− within: Text.Pandoc.Citeproc.MetaValue

8649

87−# TODO: check

88−- ignore:

89− name: "Use second"

90− within:

91− - Text.Pandoc.Citeproc.BibTeX

92− - Text.Pandoc.Citeproc.Locator

50+# Ignore some builtin hints

51+# - ignore: {name: Use let}

52+# - ignore: {name: Use const, within: SpecialModule} # Only within certain modules

53+# - ignore: {name: "Use section"}

54+# - ignore: {name: "Use camelCase"}

55+# - ignore: {name: "Use list comprehension"}

56+# - ignore: {name: "Redundant if"}

57+- ignore: {name: "Avoid lambda"}

58+- ignore: {name: "Use String"}

59+- ignore: {name: "Use isDigit"}

60+- ignore: {name: "Eta reduce"}

61+- ignore: {name: "Use fmap"} # specific for GHC 7.8 compat

62+- ignore: {name: "Parse error"} # we trust the compiler over HLint

63+- ignore: {name: "Use =="} # Creates infinite loops in `EQ` using expressions

64+- ignore: {name: "Evaluate"}

65+- ignore: {name: "Use &&&"}

66+# - ignore: {name: "Redundant compare"}

9367

94−# TODO: check

95−- ignore:

96− name: "Use sortOn"

97− within: Text.Pandoc.Writers.OpenDocument

68+# Define some custom infix operators

69+# - fixity: infixr 3 ~^#^~

9870

99−- ignore:

100− name: "Use tuple-section"

101− within:

102− - Text.Pandoc.Readers.EPUB

103− - Text.Pandoc.ImageSize

104− - Text.Pandoc.Readers.Markdown

105− - Text.Pandoc.Readers.RST

10671

107−# fromRight is only in base >= 4.10

108−- ignore:

109− name: "Use fromRight"

11072

111−# Define some custom infix operators

112−# - fixity: infixr 3 ~^#^~

.mailmapdeleted−37

@@ -1,37 +0,0 @@

1−Adam Brandizzi <brandizzi@gmail.com>

2−Albert Krewinkel <albert@zeitkraut.de> <albert+github@zeitkraut.de>

3−Albert Krewinkel <albert@zeitkraut.de> <albert.krewinkel@tourstream.eu>

4−Albert Krewinkel <albert@zeitkraut.de> <tarleb@moltkeplatz.de>

5−Albert Krewinkel <albert@zeitkraut.de> <tarleb@zeitkraut.de>

6−Alexander Krotov <ilabdsf@gmail.com>

7−Alex Ivkin <alex@ivkin.net>

8−Alex Ivkin <alex@ivkin.net> <alexivkin@users.noreply.github.com>

9−Andrew Dunning <andunning@gmail.com>

10−Andrew Dunning <andunning@gmail.com> <adunning@users.noreply.github.com>

11−Andrew Newman <andrewfnewman@gmail.com>

12−Clare Macrae <clare.macrae@googlemail.com> <github@cfmacrae.fastmail.co.uk>

13−Hugo Roy <hugo@fsfe.org>

14−Hugo Roy <hugo@xps.ampoliros.net>

15−John MacFarlane <jgm@berkeley.edu> <fiddlosopher@788f1e2b-df1e-0410-8736-df70ead52e1b>

16−John MacFarlane <jgm@berkeley.edu> <fiddlosopher@gmail.com>

17−John MacFarlane <jgm@berkeley.edu> <jgm@Johns-MacBook-Pro.local>

18−Jose Luis Duran <jlduran@gmail.com> <jlduran@users.noreply.github.com>

19−Marc Schreiber <schrieveslaach@online.de>

20−Masayoshi Takahashi <maki@rubycolor.org>

21−Matthew Pickering <matthewtpickering@gmail.com>

22−Mauro Bieg <mauro.bieg@gmail.com>

23−Mauro Bieg <mauro.bieg@gmail.com> <maurobieg@Mauros-MacBook-Air.local>

24−Mauro Bieg <mauro.bieg@gmail.com> <mb21@server.fake>

25−Mauro Bieg <mauro.bieg@gmail.com> <mb21@users.noreply.github.com>

26−Mauro Bieg <mb21@users.noreply.github.com>

27−Nils Carlson <nils.carlson@ludd.ltu.se>

28−Nils Carlson <nils.carlson@ludd.ltu.se> <pyssling@ludd.ltu.se>

29−Robin Lambertz <robinlambertz+dev@gmail.com>

30−Roland Hieber <rohieb@rohieb.name> <rohieb@users.noreply.github.com>

31−Sebastian Talmon <35015406+stalmon@users.noreply.github.com>

32−Sergei Trofimovich <slyfox@gentoo.org> <siarheit@google.com>

33−Sergei Trofimovich <slyfox@gentoo.org> <slyfox@inbox.ru>

34−Stefan Björk <stefan.bjork@gmail.com> <stefan@airistotle.local>

35−Thomas Hodgson <hello@twshodgson.net> <twsh@users.noreply.github.com>

36−Timm Albers <timmm.albers@gmail.com> <timm.albers@open-xchange.com>

37−Yan Pashkovsky <yanpaso@gmail.com> <Yanpas@users.noreply.github.com>

.stylish-haskell.yaml+4−4

@@ -41,7 +41,7 @@ steps:

4141 # Default: global.

4242 align: none

4343

44− # Following options affect only import list alignment.

44+ # Folowing options affect only import list alignment.

4545 #

4646 # List align has following options:

4747 #

@@ -75,7 +75,7 @@ steps:

7575 # short enough to fit to single line. Otherwise it'll be multiline.

7676 #

7777 # - multiline: One line per import list entry.

78− # Type with constructor list acts like single import.

78+ # Type with contructor list acts like single import.

7979 #

8080 # > import qualified Data.Map as M

8181 # > ( empty

@@ -91,7 +91,7 @@ steps:

9191 # This option affects 'list_align' and 'long_list_align'.

9292 list_padding: 4

9393

94− # Separate lists option affects formatting of import list for type

94+ # Separate lists option affects formating of import list for type

9595 # or class. The only difference is single space between type and list

9696 # of constructors, selectors and class functions.

9797 #

@@ -124,7 +124,7 @@ steps:

124124

125125 # Align affects alignment of closing pragma brackets.

126126 #

127− # - true: Brackets are aligned in same column.

127+ # - true: Brackets are aligned in same collumn.

128128 #

129129 # - false: Brackets are not aligned together. There is only one space

130130 # between actual import and closing bracket.

.travis.ymlnew file+139

@@ -0,0 +1,139 @@

1+# This .travis.yml is modified from the sample at

2+# https://docs.haskellstack.org/en/stable/GUIDE/#travis-with-caching

3+

4+# Use new container infrastructure to enable caching

5+sudo: false

6+

7+# Do not choose a language; we provide our own build tools.

8+language: generic

9+

10+# Caching so the next build will be fast too.

11+cache:

12+ directories:

13+ - $HOME/.ghc

14+ - $HOME/.cabal

15+ - $HOME/.stack

16+

17+# The different configurations we want to test. We have BUILD=cabal which uses

18+# cabal-install, and BUILD=stack which uses Stack. More documentation on each

19+# of those below.

20+#

21+# We set the compiler values here to tell Travis to use a different

22+# cache file per set of arguments.

23+#

24+# If you need to have different apt packages for each combination in the

25+# matrix, you can use a line such as:

26+# addons: {apt: {packages: [libfcgi-dev,libgmp-dev]}}

27+#

28+# fast_finish: build successful when every builds not in allow_failure are finished

29+# i.e. not waiting any of the allow_failure to finish

30+matrix:

31+ include:

32+ # We grab the appropriate GHC and cabal-install versions from hvr's PPA. See:

33+ # https://github.com/hvr/multi-ghc-travis

34+ - env: BUILD=cabal GHCVER=7.8.4 CABALVER=1.18 OPTS="-O0 -Wall -fno-warn-unused-do-bind -Werror" FLAGS="fast embed_data_files" CABALARGS="--enable-benchmarks"

35+ compiler: ": #GHC 7.8.4"

36+ addons: {apt: {packages: [cabal-install-1.18,ghc-7.8.4,happy-1.19.5], sources: [hvr-ghc]}}

37+

38+ # don't build benchmarks for ghc 7.10.3, because build takes too long...

39+ - env: BUILD=cabal GHCVER=7.10.3 CABALVER=1.22 OPTS="-O0 -Wall -fno-warn-unused-do-bind -Werror" FLAGS="fast embed_data_files" CABALARGS=""

40+ compiler: ": #GHC 7.10.3"

41+ addons: {apt: {packages: [cabal-install-1.22,ghc-7.10.3,happy-1.19.5], sources: [hvr-ghc]}}

42+

43+ # don't build benchmarks for ghc 8.0.2, because build takes too long...

44+ - env: BUILD=cabal GHCVER=8.0.2 CABALVER=1.24 OPTS="-O0 -Wall -Wincomplete-record-updates -Wnoncanonical-monad-instances -Wnoncanonical-monadfail-instances -fno-warn-unused-do-bind -Werror" FLAGS="fast" CABALARGS=""

45+ compiler: ": #GHC 8.0.2"

46+ addons: {apt: {packages: [cabal-install-1.24,ghc-8.0.2,happy-1.19.5], sources: [hvr-ghc]}}

47+

48+ - env: BUILD=cabal GHCVER=8.2.2 CABALVER=1.24 OPTS="-O0 -Wall -Wincomplete-record-updates -Wnoncanonical-monad-instances -Wnoncanonical-monadfail-instances -fno-warn-unused-do-bind -Werror" FLAGS="fast embed_data_files" CABALARGS="--enable-benchmarks"

49+ compiler: ": #GHC 8.2.2"

50+ addons: {apt: {packages: [cabal-install-1.24,ghc-8.2.2,happy-1.19.5], sources: [hvr-ghc]}}

51+

52+ - env: BUILD=cabal GHCVER=8.2.2 CABALVER=2.0 OPTS="-O0 -Wall -Wincomplete-record-updates -Wnoncanonical-monad-instances -Wnoncanonical-monadfail-instances -fno-warn-unused-do-bind -Werror" FLAGS="fast embed_data_files" CABALARGS="--enable-benchmarks"

53+ compiler: ": #GHC 8.2.2"

54+ addons: {apt: {packages: [cabal-install-2.0,ghc-8.2.2,happy-1.19.5], sources: [hvr-ghc]}}

55+

56+ # Build with the newest GHC and cabal-install. This is an accepted failure,

57+ # see below.

58+ # - env: BUILD=cabal GHCVER=head CABALVER=head CABALAGS="--allow-newer"

59+ # compiler: ": #GHC HEAD"

60+ # addons: {apt: {packages: [cabal-install-head,ghc-head], sources: [hvr-ghc]}}

61+

62+ # The Stack builds. We can pass in arbitrary Stack arguments via the ARGS

63+ # variable, such as using --stack-yaml to point to a different file.

64+ # - env: BUILD=stack ARGS="--stack-yaml stack.lts9.yaml" OPTS="-Wall -Wincomplete-record-updates -Wnoncanonical-monad-instances -Wnoncanonical-monadfail-instances -fno-warn-unused-do-bind -Werror"

65+ # compiler: ": #stack 8.0.2"

66+ # addons: {apt: {packages: [ghc-8.0.2], sources: [hvr-ghc]}}

67+

68+ - env: BUILD=stack ARGS="--resolver lts-10" OPTS="-Wall -Wincomplete-record-updates -Wnoncanonical-monad-instances -Wnoncanonical-monadfail-instances -fno-warn-unused-do-bind -Werror"

69+ compiler: ": #stack 8.2.2"

70+ addons: {apt: {packages: [ghc-8.2.2], sources: [hvr-ghc]}}

71+

72+ # Nightly builds are allowed to fail

73+ - env: BUILD=stack ARGS="--resolver nightly" OPTS="-Wall -Wincomplete-record-updates -Wnoncanonical-monad-instances -Wnoncanonical-monadfail-instances -fno-warn-unused-do-bind -Werror"

74+ compiler: ": #stack nightly"

75+ addons: {apt: {packages: [ghc-8.2.2], sources: [hvr-ghc]}}

76+

77+ # - env: BUILD=stack ARGS="--resolver lts-8"

78+ # compiler: ": #stack 8.0.2 osx"

79+ # os: osx

80+

81+ # - env: BUILD=stack ARGS="--resolver nightly"

82+ # compiler: ": #stack nightly osx"

83+ # os: osx

84+

85+ allow_failures:

86+ - env: BUILD=cabal GHCVER=head CABALVER=head

87+ - env: BUILD=stack ARGS="--resolver nightly"

88+

89+ fast_finish: true

90+

91+before_install:

92+# Using compiler above sets CC to an invalid value, so unset it

93+- unset CC

94+- export PATH=/opt/happy/1.19.5/bin/:/opt/ghc/$GHCVER/bin:/opt/cabal/$CABALVER/bin:$HOME/.local/bin:$HOME/.cabal/bin:$PATH

95+# Download and unpack the stack executable

96+- |

97+ if [[ $BUILD == "stack" ]]; then

98+ mkdir -p ~/.local/bin

99+ if [ `uname` = "Darwin" ]

100+ then

101+ curl --insecure -L https://www.stackage.org/stack/osx-x86_64 | tar xz --strip-components=1 --include '*/stack' -C ~/.local/bin

102+ else

103+ curl -L https://www.stackage.org/stack/linux-x86_64 | tar xz --wildcards --strip-components=1 -C ~/.local/bin '*/stack'

104+ fi

105+ fi

106+

107+install:

108+- echo "$(ghc --version) [$(ghc --print-project-git-commit-id 2> /dev/null || echo '?')]"

109+- if [ -f configure.ac ]; then autoreconf -i; fi

110+- |

111+ case "$BUILD" in

112+ stack)

113+ ulimit -n 4096

114+ stack config set system-ghc --global true

115+ stack --no-terminal --install-ghc $ARGS build --only-dependencies --fast --flag 'pandoc:embed_data_files' --flag 'aeson:fast' --jobs 2

116+ ;;

117+ cabal)

118+ cabal --version

119+ travis_retry cabal update

120+ cabal install --disable-optimization --only-dependencies --flags="$FLAGS" --enable-tests --force-reinstalls --reorder-goals --max-backjumps=-1 $CABALARGS

121+ ;;

122+ esac

123+

124+script:

125+- |

126+ case "$BUILD" in

127+ stack)

128+ ulimit -n 4096

129+ stack config set system-ghc --global true

130+ stack --no-terminal $ARGS test --fast --flag 'aeson:fast' --flag pandoc:embed_data_files --haddock --no-haddock-deps --ghc-options="$OPTS"

131+ ;;

132+ cabal)

133+ cabal sdist --output-directory=sourcedist && \

134+ cd sourcedist && \

135+ cabal configure --disable-optimization --enable-tests -v2 --flags="$FLAGS" --ghc-options="$OPTS" $CABALARGS && \

136+ cabal build -v2 -j2 && \

137+ cabal test

138+ ;;

139+ esac

AUTHORS.md+3−138

@@ -1,100 +1,57 @@

11# Contributors

22

3−- Anabra

4−- Aner Lucero

53- Arata Mizuki

6−- Arfon Smith

74- Aaron Wolen

85- Albert Krewinkel

96- Alex Ivkin

10−- Alex Toldaiev

117- Alex Vong

128- Alexander Kondratskiy

139- Alexander Krotov

1410- Alexander Sulfrian

1511- Alexander V Vershilov

16−- Alexandre Franke

1712- Alfred Wechselberger

18−- Amogh Rathore

19−- Anders Waldenborg

2013- Andreas Lööw

2114- Andrew Dunning

22−- Andy Morris

23−- Anti-Distinctlyminty

2415- Antoine Latter

25−- Antonio Terceiro

2616- Arata Mizuki

27−- Arfon Smith

2817- Arlo O'Keeffe

2918- Artyom Kazak

3019- Agustín Martín Barbero

3120- B. Scott Michel

3221- Ben Firshman

3322- Ben Gamari

34−- Ben Steinberg

3523- Beni Cherniavsky-Paskin

3624- Benoit Schweblin

3725- Bjorn Buckwalter

38−- Blake Eryx

39−- Bodigrim

4026- Bradley Kuhn

4127- Brent Yorgey

42−- Brian Leung

4328- Bryan O'Sullivan

4429- Caleb McDaniel

45−- Caleb Mclennan

4630- Calvin Beck

4731- Carlos Sosa

48−- Cécile Chemin

49−- Cédric Couralet

50−- Charanjit Singh

5132- Chris Black

5233- Christian Conkle

53−- Christian Despres

5434- Christoffer Ackelman

5535- Christoffer Sawicki

5636- Clare Macrae

5737- Clint Adams

5838- Conal Elliott

59−- Cormac Relf

6039- Craig S. Bosma

61−- Damien Clochard

6240- Daniel Bergey

63−- Daniel Maslowski

6441- Daniel T. Staal

6542- Daniele D'Orazio

6643- David A Roberts

6744- David Lazar

68−- David Martschenko

6945- David Röthlisberger

7046- Denis Laxalde

71−- Denis Maier

72−- Derek Chen-Becker

73−- Diego Balseiro

74−- Dimitri Sabadie

75−- Dmitry Pogodin

76−- Dmitry Volodin

7747- Douglas Calvert

78−- Eigil Rischel

7948- Emanuel Evans

80−- Emerson Harkin

81−- Emily Bourke

8249- Emily Eisenberg

8350- Eric Kow

84−- Erik Rask

8551- Eric Seidel

86−- Eric Schrijver

87−- Ethan Riley

88−- Étienne Bersac

8952- Felix Yan

90−- Félix Baylac-Jacqué

91−- Florian Beeres

9253- Florian Eitel

93−- Florian Klink

94−- Florian Kohrt

95−- Francesco Occhipinti

9654- François Gannaz

97−- Frederik Elwert

9855- Freiric Barral

9956- Freirich Raabe

10057- Frerich Raabe

@@ -108,71 +65,43 @@

10865- Gwern Branwen

10966- Hamish Mackenzie

11067- Hans-Peter Deifel

111−- Heiko Schlittermann

11268- Henrik Tramberend

11369- Henry de Valence

11470- Hubert Plociniczak

115−- Ian Max Andolina

116−- Igor Khorlo

117−- Igor Pashev

11871- Ilya V. Portnov

119−- Ivan Trubach

12072- Ivo Clarysse

121−- Jared Lander

122−- J. B. Rainsberger

12373- J. Lewis Muir

12474- Jaime Marquínez Ferrándiz

125−- Jake Zimmerman

12675- Jakob Voß

12776- James Aspnes

12877- Jamie F. Olson

12978- Jan Larres

13079- Jan Schulz

131−- Jan Tojnar

132−- Jan-Otto Kröpke

13380- Jason Ronallo

13481- Jeff Arnold

13582- Jeff Runningen

13683- Jens Getreu

13784- Jens Petersen

138−- Jeroen de Haas

139−- Jerry Sky

14085- Jesse Rosenthal

141−- Joe Hermaszewski

14286- Joe Hillenbrand

143−- John KetzerX

14487- John MacFarlane

14588- John Muccigrosso

14689- John Luke Bentley

14790- Jonas Smedegaard

148−- Jonas Scholl

14991- Jonathan Daugherty

15092- Jose Luis Duran

151−- José de Mattos Neto

15293- Josef Svenningsson

153−- Joseph C. Sible

15494- Julien Cretel

155−- Julien Dutant

156−- Juliette Fourcot

15795- Juliusz Gonera

15896- Justin Bogner

15997- Jérémy Bobbio

160−- Karl Pettersson

16198- Keiichiro Shikano

16299- Kelsey Hightower

163100- Kolen Cheung

164101- Konstantin Zudov

165102- Kristof Bastiaensen

166−- Krystof Beuermann

167103- Herwig Stuetz

168104- Lars-Dominik Braun

169−- Laurent P. René de Cotret

170−- Leif Metcalf

171−- Leonard Rosenthol

172−- Lila

173−- Loïc Grobol

174−- Lorenzo

175−- Lucas Escot

176105- Luke Plant

177106- Marc Schreiber

178107- Mark Szepieniec

@@ -181,10 +110,7 @@

181110- Masayoshi Takahashi

182111- Matej Kollar

183112- Mathias Schenner

184−- Mathias Walter

185−- Mathieu Boespflug

186113- Mathieu Duponchelle

187−- Matthew Doty

188114- Matthew Eddey

189115- Matthew Pickering

190116- Matthias C. M. Troffaes

@@ -194,66 +120,42 @@

194120- Merijn Verstraaten

195121- Michael Beaumont

196122- Michael Chladek

197−- Michael Hoffmann

198−- Michael Peyton Jones

199−- Michael Reed

200123- Michael Snoyman

201124- Michael Thompson

202−- Mike Tzou

203125- MinRK

204126- Morton Fox

205127- Nathan Gass

206128- Neil Mayhew

207129- Nick Bart

208−- Nick Berendsen

209−- Nick Fleisher

210130- Nicolas Kaiser

211131- Nikolay Yakimov

212−- Nils Carlson

213−- Nixon Enraght-Moony

214−- Nokome Bentley

215−- Ole Martin Ruud

216132- Oliver Matthews

217133- Ophir Lifshitz

218134- Or Neeman

219−- OvidiusCicero

220−- Owen McGrath

221135- Pablo Rodríguez

222−- Pascal Wagler

223−- Paul Tilley

224136- Paul Rivier

225137- Paulo Tanimoto

226−- Pete Ryland

227138- Peter Wang

228−- Philip Pesca

229139- Philippe Ombredanne

230140- Phillip Alday

231141- Prayag Verma

232142- Puneeth Chaganti

233143- Ralf Stephan

234144- Raniere Silva

235−- Raymond Ehlers

236145- Recai Oktaş

237146- Roland Hieber

238−- Roman Beránek

239147- RyanGlScott

240−- Salim B

241148- Sascha Wilde

242149- Scott Morrison

243−- Sebastian Talmon

244150- Sergei Trofimovich

245151- Sergey Astanin

246152- Shahbaz Youssefi

247153- Shaun Attfield

248−- Shim Myeongseob

249−- Shin Sang-jae

250154- Sidarth Kapur

251155- Sidharth Kapur

252156- Simon Hengel

253157- Stefan Dresselhaus

254158- Sumit Sahrawat

255−- Tarik Graba

256−- Tatiana Porras

257159- Thenaesh Elango

258160- Thomas Hodgson

259161- Thomas Weißschuh

@@ -263,54 +165,25 @@

263165- Tiziano Müller

264166- Todd Sifleet

265167- Tom Leese

266−- Tristan de Cacqueray

267−- Tristan Stenner

268168- Uli Köhler

269−- Urs Liska

270169- Václav Zeman

271−- Václav Haisman

272−- Vaibhav Sagar

273−- Vanessa McHale

274−- Vasily Alferov

275170- Viktor Kronvall

276171- Vincent

277−- Vlad Hanciuta

172+- Václav Haisman

173+- Václav Zeman

278174- Wandmalfarbe

279175- Waldir Pimenta

280176- Wikiwide

281−- Winnie Hellmann

282177- Xavier Olive

283−- Yan Pashkovsky

284−- Yoan Blanc

285178- Yuchen Pei

286−- Zihang Chen

287−- a-vrma

288−- andrebauer

289−- argent0

290−- badumont

291−- blmage

292179- bucklereed

293180- bumper314

294−- chinapedia

295−- cholonam

296181- csforste

297−- dbecher-ito

298182- d-dorazio

299−- ebiim

300−- favonia

183+- iandol

301184- infinity0x

302−- jeongminkim-islab

303−- kaizshang91

304−- lux-lth

305185- lwolfsonkin

306−- mbrackeantidot

307186- nkalvi

308−- niszet

309−- nuew

310−- obcat

311−- oltolm

312−- oquechy

313−- quasicomputational

314187- qerub

315188- robabla

316189- roblabla

@@ -318,13 +191,5 @@

318191- rski

319192- shreevatsa.public

320193- takahashim

321−- taotieren

322−- tecosaur

323−- TEC

324194- tgkokk

325−- the-solipsist

326−- timo-a

327195- thsutton

328−- vijayphoenix

329−- wiefling

330−- wuffi

CONTRIBUTING.md+37−182

@@ -1,64 +1,6 @@

11Contributing to pandoc

22======================

33

4−Welcome to pandoc! Very soon after its beginnings in 2006, pandoc

5−has been influenced, improved, and modified, by users, devs, and

6−newcomers alike. The project thrives on its active community. It is

7−great to have you here.

8−

9−How can I help?

10−---------------

11−

12−There are many ways in which you can support pandoc. Here are a few

13−ideas:

14−

15− * Participate in online discussions. The [pandoc-discuss] mailing

16− list is a good place for this. This gives valuable input and

17− makes it easier to improve the program.

18−

19− * Help with questions. Every request that is answered by the wider

20− community frees time for programming contributors. This will

21− speed up development of new features and issue fixes. Don't

22− underestimate your knowledge, please share it!

23−

24− Good places to help are the [pandoc-discuss] mailing list, Q/A

25− sites like StackOverflow, community forums (e.g.

26− [RStudio][RStudio Community], [Zettlr][Zettlr Forum]), and, for

27− technical questions, the GitHub [issue tracker].

28−

29− * Write or improve documentation. If you ran into a problem which

30− took more time to figure out than expected, please consider to

31− save other users from the same experience. People writing the

32− documentation tend to lack an outside view, so please help

33− provide one. Good documentation is both difficult and extremely

34− important.

35−

36− The official docs are not the only place for documentation.

37− Pandoc also has a [Wiki][pandoc wiki]. Private blogs can serve

38− as documentation just as the official manual can.

39−

40− * Contribute code. No matter whether it's a small fix in a format

41− template or a huge lump of Haskell code: help is welcome. It's

42− usually a good idea to talk about the plans early, as this can

43− prevent unnecessary work. See below for more information.

44−

45− * Last but not least: consider funding the development and

46− maintenance of pandoc financially. You can find sponsor buttons

47− on the [pandoc website] and the [GitHub repository][GitHub

48− repo].

49−

50−A rich ecosystem of libraries, editors, filters, and templates has

51−developed around pandoc; conversely, pandoc builds and depends on a

52−large number of libraries. Contributing to any of these projects is

53−another way that can help to ensure stability, and to keep pushing

54−the boundaries of what is possible with pandoc.

55−

56−[RStudio Community]: https://community.rstudio.com/

57−[Zettlr Forum]: https://forum.zettlr.com/

58−[pandoc wiki]: https://github.com/jgm/pandoc/wiki

59−[pandoc website]: https://pandoc.org

60−[GitHub repo]: https://github.com/jgm/pandoc

61−

624Have a question?

635----------------

646

@@ -68,21 +10,15 @@ Ask on [pandoc-discuss].

6810Found a bug?

6911------------

7012

71−Bug reports are welcome! Please report all bugs on pandoc's GitHub

13+Bug reports are welcome! Please report all bugs on pandoc's github

7214[issue tracker].

7315

7416Before you submit a bug report, search the [open issues] *and* [closed issues]

7517to make sure the issue hasn't come up before. Also, check the [User's Guide] and

7618[FAQs] for anything relevant.

7719

78−Make sure you can reproduce the bug with the [latest released

79−version] of pandoc---or, even better, the development version,

80−since the bug may have been fixed since the last release.

81−[Nightly builds] are available, so you don't need to compile

82−from source to test against the development version.

83−(To fetch a nightly, visit the link, click the topmost "Nightly"

84−in the table, then choose your platform under "Artifacts." Note

85−that you must be logged in with a GitHub account.)

20+Make sure you can reproduce the bug with the [latest released version] of pandoc

21+(or, even better, the [development version]).

8622

8723Your report should give detailed, *reproducible* instructions, including

8824

@@ -129,7 +65,7 @@ tags. These are used to indicate the *complexity* and *nature* of a

12965bug. There is not yet a way to indicate priority. An up to date

13066summary of issues can be found on [GitHub labels].

13167

132−* [good first issue] — The perfect starting point for new contributors. The

68+* [beginner-friendly] — The perfect starting point for new contributors. The

13369 issue is generic and can be resolved without deep knowledge of the code

13470 base.

13571* [enhancement] — A feature which would be desirable. We recommend

@@ -163,12 +99,7 @@ Explain the rationale for the feature you're requesting. Why would this

16399feature be useful? Consider also any possible drawbacks, including backwards

164100compatibility, new library dependencies, and performance issues.

165101

166−Features are very rarely "implement and forget", as all code must be

167−maintained. This is especially relevant for large or complex

168−contributions. It is helpful to be sympathetic to that fact, and to

169−communicate future plans and availability clearly.

170−

171−Any potential new feature is best discussed on [pandoc-discuss]

102+It is best to discuss a potential new feature on [pandoc-discuss]

172103before opening an issue.

173104

174105Patches and pull requests

@@ -213,9 +144,13 @@ Please follow these guidelines:

2131449. It is better not to introduce new dependencies. Dependencies on

214145 external C libraries should especially be avoided.

215146

216−10. We aim for compatibility with ghc versions from 8.0 to the

147+10. We aim for compatibility with ghc versions from 7.8.3 to the

217148 latest release. All pull requests and commits are tested

218− automatically on GitHub Actions.

149+ automatically on <travis-ci.org>, using GHC versions in the

150+ `Tested-With` stanza of `pandoc.cabal`. We currently relax

151+ the "`-Wall` clean" requirement for GHC 7.10.x, because

152+ there are so many warnings relating to the addition of type

153+ classes to the Prelude.

219154

220155Tests

221156-----

@@ -234,77 +169,6 @@ or, if you're using [stack],

234169

235170The test program is `test/test-pandoc.hs`.

236171

237−To run particular tests (pattern-matching on their names), use

238−the `-p` option:

239−

240− cabal install pandoc --enable-tests

241− cabal test --test-options='-p markdown'

242−

243−Or with stack:

244−

245− stack test --test-arguments='-p markdown'

246−

247−It is often helpful to add `-j4` (run tests in parallel) and

248−`--hide-successes` (don't clutter output with successes) to the test

249−arguments as well. Collecting all options in a `cabal.project.local`

250−file in the project's root directory can help to keep `cabal`

251−commands short. E.g.:

252−

253− flags: +embed_data_files

254− tests: True

255− test-show-details: direct

256− test-options: -j4 --hide-successes

257−

258−If you add a new feature to pandoc, please add tests as well, following

259−the pattern of the existing tests. The test suite code is in

260−`test/test-pandoc.hs`. If you are adding a new reader or writer, it is

261−probably easiest to add some data files to the `test` directory, and

262−modify `test/Tests/Old.hs`. Otherwise, it is better to modify the module

263−under the `test/Tests` hierarchy corresponding to the pandoc module you

264−are changing. Alternatively, you may add a "command test" to

265−the `/test/command/` hierarchy, following the pattern of the tests there.

266−These test files should have a meaningful name, which can include the issue

267−number and/or the feature that's being tested. For example, `5474-tables.md`

268−refers to both issue and feature.

269−

270−You can rebuild the golden tests in `tests/` by passing

271−`--accept` to the test script. (If you're using stack, `stack

272−test --test-arguments "--accept"`; or `make TESTARGS=--accept`).

273−Then check the changed golden files for accuracy, and

274−commit the changes. For docx or pptx tests, open the files in Word

275−or Powerpoint to ensure that they weren't corrupted and that

276−they had the expected result, and mention the Word/Powerpoint

277−version and OS in your commit comment.

278−

279−Code style

280−----------

281−

282−Pandoc uses [hlint] to identify opportunities for code improvements

283−like redundant brackets or unnecessary `Language` extensions.

284−However, sometimes there are cases where there are good reasons to

285−use code different from what hlint proposes. In these cases, the

286−respective warning should be disabled in the file `.hlint.yaml`.

287−

288−There should be no errors when running `hlint .`; this is checked by

289−the continuous integration (CI) setup. It is recommended that

290−contributors check their code with a local hlint installation, but

291−relying on the CI is fine, too.

292−

293−A good way to ensure no new warnings are introduced is to use a Git

294−[pre-commit hook] which runs hlint on all updated Haskell files

295−before creating a commit:

296−

297− #!/bin/sh

298− git diff --diff-filter=MA --cached --name-only | grep '\.hs$' | \

299− xargs hlint --hint .hlint.yaml

300−

301−(If you are using GNU `xargs`, add the `-r` option immediately

302−after `xargs`.)

303−

304−Saving this to `.git/hooks/pre-commit`, and making the script

305−executable, will prevent accidental introduction of potentially

306−problematic code.

307−

308172Benchmarks

309173----------

310174

@@ -318,29 +182,29 @@ With stack:

318182

319183 stack bench

320184

185+You can also build pandoc with the `weigh-pandoc` flag and

186+run `weigh-pandoc` to get some statistics on memory usage.

187+(Eventually this should be incorporated into the benchmark

188+suite.)

321189

322190Using the REPL

323191--------------

324192

325193With a recent version of cabal, you can do `cabal repl` and get

326194a ghci REPL for working with pandoc. With [stack], use

327−`stack ghci`.

195+`cabal ghci`.

328196

329197We recommend using the following `.ghci` file (which can be

330198placed in the source directory):

331199

332− :set -fobject-code

333− :set -XTypeSynonymInstances

334− :set -XScopedTypeVariables

335− :set -XOverloadedStrings

200+ :set -fobject-code

201+ :set -XTypeSynonymInstances

202+ :set -XScopedTypeVariables

203+ :set -XOverloadedStrings

336204

337205Profiling

338206---------

339207

340−To diagnose a performance issue with parsing, first try using

341−the `--trace` option. This will give you a record of when block

342−parsers succeed, so you can spot backtracking issues.

343−

344208To use the GHC profiler with cabal:

345209

346210 cabal clean

@@ -376,7 +240,7 @@ The code

376240--------

377241

378242Pandoc has a publicly accessible git repository on

379−GitHub: <https://github.com/jgm/pandoc>. To get a local copy of the source:

243+github: <http://github.com/jgm/pandoc>. To get a local copy of the source:

380244

381245 git clone https://github.com/jgm/pandoc.git

382246

@@ -386,7 +250,7 @@ the pandoc library is in `src/`, the source for the tests is in

386250

387251The modules `Text.Pandoc.Definition`, `Text.Pandoc.Builder`, and

388252`Text.Pandoc.Generic` are in a separate library `pandoc-types`. The code can

389−be found in <https://github.com/jgm/pandoc-types>.

253+be found in <http://github.com/jgm/pandoc-types>.

390254

391255To build pandoc, you will need a working installation of the

392256[Haskell platform].

@@ -399,18 +263,18 @@ The library is structured as follows:

399263 - `Text.Pandoc.Definition` (in `pandoc-types`) defines the types

400264 used for representing a pandoc document.

401265 - `Text.Pandoc.Builder` (in `pandoc-types`) provides functions for

402− building pandoc documents programmatically.

266+ building pandoc documents programatically.

403267 - `Text.Pandoc.Generics` (in `pandoc-types`) provides functions allowing

404268 you to promote functions that operate on parts of pandoc documents

405269 to functions that operate on whole pandoc documents, walking the

406270 tree automatically.

407271 - `Text.Pandoc.Readers.*` are the readers, and `Text.Pandoc.Writers.*`

408272 are the writers.

409− - `Text.Pandoc.Citeproc.*` contain the code for citation handling,

410− including an interface to the [citeproc] library.

273+ - `Text.Pandoc.Biblio` is a utility module for formatting citations

274+ using citeproc-hs.

411275 - `Text.Pandoc.Data` is used to embed data files when the `embed_data_files`

412− cabal flag is used.

413− - `Text.Pandoc.Emoji` is a thin wrapper around [emojis].

276+ cabal flag is used. It is generated from `src/Text/Pandoc/Data.hsb` using

277+ the preprocessor [hsb2hs].

414278 - `Text.Pandoc.Highlighting` contains the interface to the

415279 skylighting library, which is used for code syntax highlighting.

416280 - `Text.Pandoc.ImageSize` is a utility module containing functions for

@@ -421,6 +285,7 @@ The library is structured as follows:

421285 - `Text.Pandoc.PDF` contains functions for producing a PDF from a

422286 LaTeX source.

423287 - `Text.Pandoc.Parsing` contains parsing functions used in multiple readers.

288+ - `Text.Pandoc.Pretty` is a pretty-printing library specialized to

424289 the needs of pandoc.

425290 - `Text.Pandoc.SelfContained` contains functions for making an HTML

426291 file "self-contained," by importing remotely linked images, CSS,

@@ -437,30 +302,19 @@ The library is structured as follows:

437302 - `Text.Pandoc.UUID` contains functions for generating UUIDs.

438303 - `Text.Pandoc.XML` contains functions for formatting XML.

439304

440−Lua filters

441−-----------

442−

443−If you've written a useful pandoc [lua filter](lua-filters.html),

444−you may want to consider submitting a pull request to the

445−[lua-filters repository](https://github.com/pandoc/lua-filters).

446−

447305[open issues]: https://github.com/jgm/pandoc/issues

448306[closed issues]: https://github.com/jgm/pandoc/issues?q=is%3Aissue+is%3Aclosed

449307[latest released version]: https://github.com/jgm/pandoc/releases/latest

450−[Nightly builds]: https://github.com/jgm/pandoc/actions?query=workflow%3ANightly

451−[pandoc-discuss]: https://groups.google.com/group/pandoc-discuss

308+[development version]: https://github.com/pandoc-extras/pandoc-nightly/releases/latest

309+[pandoc-discuss]: http://groups.google.com/group/pandoc-discuss

452310[issue tracker]: https://github.com/jgm/pandoc/issues

453−[User's Guide]: https://pandoc.org/MANUAL.html

454−[FAQs]: https://pandoc.org/faqs.html

455−[EditorConfig]: https://editorconfig.org/

456−[Haskell platform]: https://www.haskell.org/platform/

457−[hlint]: https://hackage.haskell.org/package/hlint

458−[citeproc]: https://hackage.haskell.org/package/citeproc

459−[emojis]: https://hackage.haskell.org/package/emojis

460−[hsb2hs]: https://hackage.haskell.org/package/hsb2hs

461−[pre-commit hook]: https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks

311+[User's Guide]: http://pandoc.org/MANUAL.html

312+[FAQs]: http://pandoc.org/faqs.html

313+[EditorConfig]: http://editorconfig.org/

314+[Haskell platform]: http://www.haskell.org/platform/

315+[hsb2hs]: http://hackage.haskell.org/package/hsb2hs

462316[GitHub labels]: https://github.com/jgm/pandoc/labels

463−[good first issue]:https://github.com/jgm/pandoc/labels/good%20first%20issue

317+[beginner-friendly]: https://github.com/jgm/pandoc/labels/beginner-friendly

464318[enhancement]: https://github.com/jgm/pandoc/labels/enhancement

465319[bug]: https://github.com/jgm/pandoc/labels/bug

466320[complexity:low]: https://github.com/jgm/pandoc/labels/complexity:low

@@ -473,3 +327,4 @@ you may want to consider submitting a pull request to the

473327[status:more-discussion-needed]: https://github.com/jgm/pandoc/labels/status:more-discussion-needed

474328[status:more-info-needed]: https://github.com/jgm/pandoc/labels/status:more-info-needed

475329[stack]: https://github.com/commercialhaskell/stack

330+

COPYING.md+1−1

@@ -357,5 +357,5 @@ into proprietary programs. If your program is a subroutine library,

357357you may consider it more useful to permit linking proprietary

358358applications with the library. If this is what you want to do, use the

359359[GNU Lesser General Public

360−License](https://www.gnu.org/licenses/lgpl.html) instead of this

360+License](http://www.gnu.org/licenses/lgpl.html) instead of this

361361License.

COPYRIGHT+35−54

@@ -1,5 +1,5 @@

11Pandoc

2−Copyright (C) 2006-2021 John MacFarlane <jgm at berkeley dot edu>

2+Copyright (C) 2006-2017 John MacFarlane <jgm at berkeley dot edu>

33

44With the exceptions noted below, this code is released under the [GPL],

55version 2 or later:

@@ -22,11 +22,11 @@ The GNU General Public License is available in the file COPYING.md in

2222the source distribution. On Debian systems, the complete text of the

2323GPL can be found in `/usr/share/common-licenses/GPL`.

2424

25−[GPL]: https://www.gnu.org/copyleft/gpl.html

25+[GPL]: http://www.gnu.org/copyleft/gpl.html

2626

2727Pandoc's complete source code is available from the [Pandoc home page].

2828

29−[Pandoc home page]: https://pandoc.org

29+[Pandoc home page]: http://pandoc.org

3030

3131Pandoc includes some code with different copyrights, or subject to different

3232licenses. The copyright and license statements for these sources are included

@@ -37,7 +37,7 @@ The modules in the `pandoc-types` repository (Text.Pandoc.Definition,

3737Text.Pandoc.Builder, Text.Pandoc.Generics, Text.Pandoc.JSON,

3838Text.Pandoc.Walk) are licensed under the BSD 3-clause license:

3939

40−Copyright (c) 2006-2021, John MacFarlane

40+Copyright (c) 2006-2017, John MacFarlane

4141

4242All rights reserved.

4343

@@ -69,33 +69,32 @@ THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

6969OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

7070

7171----------------------------------------------------------------------

72−Pandoc's templates (in `data/templates`) are dual-licensed as either

73−GPL (v2 or higher, same as pandoc) or (at your option) the BSD

74−3-clause license.

72+Pandoc's templates (in `data/templates`) are dual-licensed GPL (v2 or

73+higher, same as pandoc) and the BSD 3-clause license.

7574

76−Copyright (c) 2014--2021, John MacFarlane

75+Copyright (c) 2014--2017, John MacFarlane

7776

7877----------------------------------------------------------------------

7978src/Text/Pandoc/Writers/Muse.hs

80−Copyright (C) 2017-2020 Alexander Krotov

79+Copyright (C) 2017 Alexander Krotov

8180

8281Released under the GNU General Public License version 2 or later.

8382

8483----------------------------------------------------------------------

8584src/Text/Pandoc/Writers/Texinfo.hs

86−Copyright (C) 2008-2021 John MacFarlane and Peter Wang

85+Copyright (C) 2008-2017 John MacFarlane and Peter Wang

8786

8887Released under the GNU General Public License version 2 or later.

8988

9089----------------------------------------------------------------------

9190src/Text/Pandoc/Writers/OpenDocument.hs

92−Copyright (C) 2008-2021 Andrea Rossato and John MacFarlane

91+Copyright (C) 2008-2017 Andrea Rossato and John MacFarlane

9392

9493Released under the GNU General Public License version 2 or later.

9594

9695----------------------------------------------------------------------

9796src/Text/Pandoc/Writers/Org.hs

98−Copyright (C) 2010-2021 Puneeth Chaganti, John MacFarlane, and

97+Copyright (C) 2010-2017 Puneeth Chaganti, John MacFarlane, and

9998 Albert Krewinkel

10099

101100Released under the GNU General Public License version 2 or later.

@@ -109,81 +108,54 @@ Released under the GNU General Public License version 2 or later.

109108----------------------------------------------------------------------

110109src/Text/Pandoc/Readers/Docx.hs

111110src/Text/Pandoc/Readers/Docx/*

112−Copyright (C) 2014-2020 Jesse Rosenthal

111+Copyright (C) 2014-2017 Jesse Rosenthal

113112

114113Released under the GNU General Public License version 2 or later.

115114

116115----------------------------------------------------------------------

117116src/Text/Pandoc/Readers/Textile.hs

118−Copyright (C) 2010-2021 Paul Rivier and John MacFarlane

119−

120−Released under the GNU General Public License version 2 or later.

121−

122−----------------------------------------------------------------------

123−src/Text/Pandoc/Readers/TikiWiki.hs

124−Copyright (C) 2017 Robin Lee Powell

125−

126−Released under the GNU General Public License version 2 or later.

127−

128−----------------------------------------------------------------------

129−src/Text/Pandoc/Readers/JATS.hs

130−Copyright (C) 2017-2018 Hamish Mackenzie

131−

132−Released under the GNU General Public License version 2 or later.

133−

134−----------------------------------------------------------------------

135−src/Text/Pandoc/Readers/EPUB.hs

136−Copyright (C) 2014-2021 Matthew Pickering and John MacFarlane

117+Copyright (C) 2010-2017 Paul Rivier and John MacFarlane

137118

138119Released under the GNU General Public License version 2 or later.

139120

140121----------------------------------------------------------------------

141122src/Text/Pandoc/Readers/Org.hs

142−src/Text/Pandoc/Readers/Org/*

143−test/Tests/Readers/Org/*

144−Copyright (C) 2014-2021 Albert Krewinkel

145−

146−Released under the GNU General Public License version 2 or later.

147−

148−----------------------------------------------------------------------

149−src/Text/Pandoc/Lua.hs

150−src/Text/Pandoc/Lua/*

151−test/lua/*

152−Copyright (C) 2017--2021 Albert Krewinkel and John MacFarlane

123+test/Tests/Readers/Org.hs

124+Copyright (C) 2014-2017 Albert Krewinkel

153125

154126Released under the GNU General Public License version 2 or later.

155127

156128----------------------------------------------------------------------

157−src/Text/Pandoc/Readers/Jira.hs

158−src/Text/Pandoc/Writers/Jira.hs

159−test/Tests/Readers/Jira.hs

160−Copyright (C) 2019--2021 Albert Krewinkel

129+data/LaTeXMathML.js

130+Adapted by Jeff Knisely and Douglas Woodall from

131+ASCIIMathML.js v. 1.4.7

132+Copyright (C) 2005 Peter Jipsen

161133

162134Released under the GNU General Public License version 2 or later.

163135

164136----------------------------------------------------------------------

165−src/Text/Pandoc/Readers/FB2.hs

166−Copyright (C) 2018--2019 Alexander Krotov

137+data/MathMLinHTML.js

138+Copyright (C) 2004 Peter Jipsen http://www.chapman.edu/~jipsen

167139

168140Released under the GNU General Public License version 2 or later.

169141

170−----------------------------------------------------------------------

142+------------------------------------------------------------------------

171143data/pandoc.lua

172−Copyright (C) 2017-2021 Albert Krewinkel

144+Copyright (C) 2017 Albert Krewinkel

173145

174146Released under the GNU General Public License version 2 or later.

175147

176148----------------------------------------------------------------------

177149The dzslides template contains JavaScript and CSS from Paul Rouget's

178150dzslides template.

179−https://github.com/paulrouget/dzslides

151+http://github.com/paulrouget/dzslides

180152

181153Released under the Do What the Fuck You Want To Public License.

182154

183155------------------------------------------------------------------------

184−Pandoc embeds a Lua interpreter (via hslua).

156+Pandoc embeds a lua interpreter (via hslua).

185157

186−Copyright © 1994–2020 Lua.org, PUC-Rio.

158+Copyright © 1994–2015 Lua.org, PUC-Rio.

187159

188160Permission is hereby granted, free of charge, to any person obtaining

189161a copy of this software and associated documentation files (the

@@ -203,3 +175,12 @@ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE

203175LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION

204176OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION

205177WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

178+

179+------------------------------------------------------------------------

180+The template pandoc.jats is Copyright 2013--15 Martin Fenner,

181+released under GPL version 2 or later.

182+

183+The file data/jats.csl is derived from a csl file by Martin Fenner,

184+revised by Martin Paul Eve and then John MacFarlane.

185+"This work is licensed under a Creative Commons Attribution-ShareAlike 3.0

186+License. Originally by Martin Fenner."

INSTALL.md+95−176

@@ -1,167 +1,94 @@

11# Installing pandoc

22

3−The simplest way to get the latest pandoc release is to use the installer.

4−

5−<a href="https://github.com/jgm/pandoc/releases/latest"

6− class="btn btn-primary" id="downloadInstallerBtn">

7− Download the latest installer

8−</a>

9−

10−For alternative ways to install pandoc, see below

11−under the heading for your operating system.

12−

133## Windows

144

15−There is a package installer at pandoc's [download page].

16−This will install pandoc, replacing older versions, and

17−update your path to include the directory where pandoc's

18−binaries are installed.

19−

20−If you prefer not to use the msi installer, we also provide

21−a zip file that contains pandoc's binaries and

22−documentation. Simply unzip this file and move the binaries

23−to a directory of your choice.

24−

25−Alternatively, you can install pandoc using

26−[Chocolatey](https://chocolatey.org):

27−

28− choco install pandoc

29−

30−Chocolatey can also install other software that integrates with Pandoc.

31−For example, to install `rsvg-convert` (from [librsvg], covering formats

32−without SVG support), [Python] (to use Pandoc filters), and

33−[MiKTeX] (to typeset PDFs with [LaTeX]):

34−

35− choco install rsvg-convert python miktex

5+ - There is a package installer at pandoc's [download page].

6+ This will install pandoc, replacing older versions, and

7+ update your path to include the directory where pandoc's

8+ binaries are installed.

369

37−Using multiple installation methods can result in two separate

38−installations of pandoc; it is recommended to properly uninstall

39−pandoc before switching to an alternative installation method.

10+ - If you prefer not to use the msi installer, we also provide

11+ a zip file that contains pandoc's binaries and

12+ documentation. Simply unzip this file and move the binaries

13+ to a directory of your choice.

4014

41−By default, Pandoc creates PDFs using LaTeX.

42−We recommend installing it via [MiKTeX].

15+ - For PDF output, you'll also need to install LaTeX.

16+ We recommend [MiKTeX](http://miktex.org/).

4317

4418## macOS

4519

46−There is a package installer at pandoc's [download page].

47−If you later want to uninstall the package, you can do so

48−by downloading [this script][uninstaller]

49−and running it with `perl uninstall-pandoc.pl`.

20+ - You can install pandoc using

21+ [homebrew](http://brew.sh): `brew install pandoc`.

5022

51−Alternatively, you can install pandoc using

52−[Homebrew](https://brew.sh):

23+ - There is a package installer at pandoc's [download page].

24+ If you later want to uninstall the package, you can do so

25+ by downloading [this script][uninstaller]

26+ and running it with `perl uninstall-pandoc.pl`.

5327

54− brew install pandoc

28+ - We also provide a zip file containing the binaries and man

29+ pages, for those who prefer not to use the installer. Simply

30+ unzip the file and move the binaries and man pages to

31+ whatever directory you like.

5532

56−Homebrew can also install other software that integrates with Pandoc.

57−For example, to install [librsvg] (its `rsvg-convert` covers formats

58−without SVG support), [Python] (to use Pandoc filters), and

59−[BasicTeX] (to typeset PDFs with [LaTeX]):

33+ - For PDF output, you'll also need LaTeX. Because a full [MacTeX]

34+ installation takes more than a gigabyte of disk space, we recommend

35+ installing [BasicTeX](http://www.tug.org/mactex/morepackages.html)

36+ (64M) and using the `tlmgr` tool to install additional packages

37+ as needed. If you get errors warning of fonts not found, try

6038

61− brew install librsvg python homebrew/cask/basictex

62−

63−Note: On unsupported versions of macOS (more than three releases old),

64−Homebrew installs from source, which takes additional time and disk space

65−for the `ghc` compiler and dependent Haskell libraries.

66−

67−We also provide a zip file containing the binaries and man

68−pages, for those who prefer not to use the installer. Simply

69−unzip the file and move the binaries and man pages to

70−whatever directory you like.

71−

72−By default, Pandoc creates PDFs using LaTeX. Because a full [MacTeX]

73−installation uses four gigabytes of disk space, we recommend

74−[BasicTeX] or [TinyTeX](https://yihui.org/tinytex/)

75−and using the `tlmgr` tool to install additional packages

76−as needed. If you receive errors warning of fonts not found:

77−

78− tlmgr install collection-fontsrecommended

39+ tlmgr install collection-fontsrecommended

7940

8041## Linux

8142

82−Check whether the pandoc version in your package manager is

83−not outdated. Pandoc is in the [Debian], [Ubuntu], [Slackware],

84−[Arch], [Fedora], [NiXOS], [openSUSE], [gentoo] and [Void] repositories.

85−

86−To get the latest release, we provide a binary package for amd64

87−architecture on the **[download page]**.

88−

89−The executable is statically linked and

90−has no dynamic dependencies or dependencies on external

91−data files. Note: because of the static

92−linking, the pandoc binary from this package cannot use lua

93−filters that require external lua modules written in C.

94−

95−Both a tarball and a deb installer are provided. To install the deb:

96−

97− sudo dpkg -i $DEB

43+ - First, try your package manager.

44+ Pandoc is in the [Debian], [Ubuntu], [Slackware],

45+ [Arch], [Fedora], [NiXOS], [openSUSE], and [gentoo] repositories.

46+ Note, however, that versions in the repositories are often

47+ old.

9848

99−where `$DEB` is the path to the downloaded deb. This will

100−install the `pandoc` executable and man page.

49+ - We provide a binary package for amd64 architecture on

50+ the [download page]. This provides both `pandoc` and

51+ `pandoc-citeproc`. The executables are statically linked and

52+ have no dynamic dependencies or dependencies on external

53+ data files. Note: because of the static

54+ linking, the pandoc binary from this package cannot use lua

55+ filters that require external lua modules written in C.

10156

102−If you use an RPM-based distro, you may be able to install

103−the deb from our download page using `alien`.

57+ Both a tarball and a deb installer are provided. To install the deb:

10458

105−On any distro, you may install from the tarball into `$DEST`

106−(say, `/usr/local/` or `$HOME/.local`) by doing

59+ sudo dpkg -i $DEB

10760

108− tar xvzf $TGZ --strip-components 1 -C $DEST

61+ where `$DEB` is the path to the downloaded deb. This will

62+ install the `pandoc` and `pandoc-citeproc` executables and

63+ man pages.

10964

110−where `$TGZ` is the path to the downloaded zipped tarball.

111−For Pandoc versions before 2.0, which don't provide

112−a tarball, try instead

65+ If you use an RPM-based distro, you may be able to install

66+ the deb from our download page using `alien`.

11367

114− ar p $DEB data.tar.gz | tar xvz --strip-components 2 -C $DEST

68+ On any distro, you may install from the tarball into `$DEST`

69+ (say, `/usr/local/` or `$HOME/.local`) by doing

11570

116−You can also install from source, using the

117−instructions below under [Compiling from source].

118−Note that most distros have the Haskell platform in their

119−package repositories. For example, on Debian/Ubuntu,

120−you can install it with `apt-get install haskell-platform`.

71+ tar xvzf $TGZ --strip-components 1 -C $DEST

12172

122−For PDF output, you'll need LaTeX. We recommend installing

123−[TeX Live](https://www.tug.org/texlive/) via your package

124−manager. (On Debian/Ubuntu, `apt-get install texlive`.)

73+ where `$TGZ` is the path to the downloaded zipped tarball.

74+ For Pandoc versions before 2.0, which don't provide

75+ a tarball, try instead

12576

126−## Chrome OS

77+ ar p $DEB data.tar.gz | tar xvz --strip-components 2 -C $DEST

12778

128−On Chrome OS, pandoc can be installed using the

129−[chromebrew](https://github.com/skycocker/chromebrew) package manager

130−with the command:

79+ - You can also install from source, using the

80+ instructions below under [Compiling from source].

81+ Note that most distros have the Haskell platform in their

82+ package repositories. For example, on Debian/Ubuntu,

83+ you can install it with `apt-get install haskell-platform`.

13184

132−```sh

133−crew install pandoc

134−```

135−

136−This will automatically build and configure pandoc for the specific

137−device you are using.

85+ - For PDF output, you'll need LaTeX. We recommend installing

86+ [TeX Live](http://www.tug.org/texlive/) via your package

87+ manager. (On Debian/Ubuntu, `apt-get install texlive`.)

13888

13989## BSD

14090

141−Pandoc is in the [NetBSD] and [FreeBSD ports] repositories.

142−

143−## Docker

144−

145−The official Docker images for pandoc can be found at

146−<https://github.com/pandoc/dockerfiles> and at

147−[dockerhub](https://hub.docker.com/).

148−

149−The [pandoc/core](https://hub.docker.com/r/pandoc/core)

150−image contains `pandoc`.

151−

152−The [pandoc/latex](https://hub.docker.com/r/pandoc/latex)

153−image also contains the minimal LaTeX installation needed

154−to produce PDFs using pandoc.

155−

156−To run pandoc using Docker, converting `README.md` to `README.pdf`:

157−

158− docker run --rm --volume "`pwd`:/data" --user `id -u`:`id -g` pandoc/latex README.md -o README.pdf

159−

160−## GitHub Actions

161−

162−Pandoc can be run through

163−[GitHub Actions](https://github.com/features/actions). For some

164−examples, see <https://github.com/pandoc/pandoc-action-example>.

91+ - Pandoc is in the [NetBSD] and [FreeBSD ports] repositories.

16592

16693## Compiling from source

16794

@@ -191,14 +118,14 @@ the last released version.

191118

192119### Quick stack method

193120

194−The easiest way to build pandoc from source is to use [stack][stack]:

121+The easiest way to build pandoc from source is to use [stack]:

195122

196−1. Install [stack][stack]. Note that Pandoc requires stack >= 1.7.0.

123+1. Install [stack].

197124

1981252. Change to the pandoc source directory and issue the following commands:

199126

200127 stack setup

201− stack install

128+ stack install --test

202129

203130 `stack setup` will automatically download the ghc compiler

204131 if you don't have it. `stack install` will install the

@@ -210,23 +137,15 @@ The easiest way to build pandoc from source is to use [stack][stack]:

210137

2111381. Install the [Haskell platform]. This will give you [GHC] and

212139 the [cabal-install] build tool. Note that pandoc requires

213− GHC >= 7.10 and cabal >= 2.0.

140+ GHC >= 7.8.

214141

2151422. Update your package database:

216143

217144 cabal update

218145

219−3. Check your cabal version with

220−

221− cabal --version

222−

223− If you have a version less than 2.0, install the latest with:

224−

225− cabal install cabal-install

146+3. Use `cabal` to install pandoc and its dependencies:

226147

227−4. Use `cabal` to install pandoc and its dependencies:

228−

229− cabal install pandoc

148+ cabal install pandoc --enable-tests

230149

231150 This procedure will install the released version of pandoc,

232151 which will be downloaded automatically from HackageDB.

@@ -237,35 +156,42 @@ The easiest way to build pandoc from source is to use [stack][stack]:

237156

238157 cabal install

239158

240−5. Make sure the `$CABALDIR/bin` directory is in your path. You should

159+4. Make sure the `$CABALDIR/bin` directory is in your path. You should

241160 now be able to run `pandoc`:

242161

243162 pandoc --help

244163

245− [Not sure where `$CABALDIR` is?](https://wiki.haskell.org/Cabal-Install#The_cabal-install_configuration_file)

164+ [Not sure where `$CABALDIR` is?](http://www.haskell.org/haskellwiki/Cabal-Install#The_cabal-install_configuration_file)

165+

166+5. If you want to process citations with pandoc, you will also need to

167+ install a separate package, `pandoc-citeproc`. This can be installed

168+ using cabal:

246169

247−5. By default `pandoc` uses the "i;unicode-casemap" method

170+ cabal install pandoc-citeproc

171+

172+ By default `pandoc-citeproc` uses the "i;unicode-casemap" method

248173 to sort bibliography entries (RFC 5051). If you would like to

249174 use the locale-sensitive unicode collation algorithm instead,

250− specify the `icu` flag (which affects the dependency `citeproc`):

175+ specify the `unicode_collation` flag:

251176

252− cabal install pandoc -ficu

177+ cabal install pandoc-citeproc -funicode_collation

253178

254179 Note that this requires the `text-icu` library, which in turn

255180 depends on the C library `icu4c`. Installation directions

256− vary by platform. Here is how it might work on macOS with Homebrew:

181+ vary by platform. Here is how it might work on macOS with homebrew:

257182

258183 brew install icu4c

259− stack install pandoc \

260− --flag "citeproc:icu" \

261− --extra-lib-dirs=/usr/local/opt/icu4c/lib \

262− --extra-include-dirs=/usr/local/opt/icu4c/include

184+ cabal install --extra-lib-dirs=/usr/local/Cellar/icu4c/51.1/lib \

185+ --extra-include-dirs=/usr/local/Cellar/icu4c/51.1/include \

186+ -funicode_collation text-icu pandoc-citeproc

263187

2641886. The `pandoc.1` man page will be installed automatically. cabal shows

265189 you where it is installed: you may need to set your `MANPATH`

266190 accordingly. If `MANUAL.txt` has been modified, the man page can be

267191 rebuilt: `make man/pandoc.1`.

268192

193+ The `pandoc-citeproc.1` man page will also be installed automatically.

194+

269195

270196### Custom cabal method

271197

@@ -274,7 +200,6 @@ over the build and installation. Most users should use the

274200quick install, but this information may be of use to packagers.

275201For more details, see the [Cabal User's Guide]. These instructions

276202assume that the pandoc source directory is your working directory.

277−You will need cabal version 2.0 or higher.

278203

2792041. Install dependencies: in addition to the [Haskell platform],

280205 you will need a number of additional libraries. You can install

@@ -347,7 +272,6 @@ test`.

347272To run particular tests (pattern-matching on their names), use

348273the `-p` option:

349274

350− cabal install pandoc --enable-tests

351275 cabal test --test-options='-p markdown'

352276

353277Or with stack:

@@ -387,29 +311,24 @@ To run just the markdown benchmarks:

387311

388312

389313[Arch]: https://www.archlinux.org/packages/community/x86_64/pandoc/

390−[Cabal User's Guide]: https://cabal.readthedocs.io/

314+[Cabal User's Guide]: http://www.haskell.org/cabal/release/latest/doc/users-guide/builders.html#setup-configure-paths

391315[Debian]: https://packages.debian.org/pandoc

392316[Fedora]: https://apps.fedoraproject.org/packages/pandoc

393−[FreeBSD ports]: https://www.freshports.org/textproc/hs-pandoc/

394−[GHC]: https://www.haskell.org/ghc/

395−[Haskell platform]: https://hackage.haskell.org/platform/

396−[MacPorts]: https://trac.macports.org/browser/trunk/dports/textproc/pandoc/Portfile

317+[FreeBSD ports]: http://www.freshports.org/textproc/pandoc/

318+[GHC]: http://www.haskell.org/ghc/

319+[GPL]: http://www.gnu.org/copyleft/gpl.html

320+[Haskell platform]: http://hackage.haskell.org/platform/

321+[MacPorts]: http://trac.macports.org/browser/trunk/dports/textproc/pandoc/Portfile

397322[MacTeX]: https://tug.org/mactex/

398−[BasicTeX]: https://www.tug.org/mactex/morepackages.html

399−[LaTeX]: https://www.latex-project.org

400−[MiKTeX]: https://miktex.org/

401−[librsvg]: https://wiki.gnome.org/Projects/LibRsvg

402−[Python]: https://www.python.org

403−[NetBSD]: https://pkgsrc.se/wip/pandoc

323+[NetBSD]: http://pkgsrc.se/wip/pandoc

404324[NixOS]: https://nixos.org/nixos/packages.html

405325[Slackware]: https://www.slackbuilds.org/result/?search=pandoc&sv=

406326[Ubuntu]: https://packages.ubuntu.com/pandoc

407327[download page]: https://github.com/jgm/pandoc/releases/latest

408−[gentoo]: https://packages.gentoo.org/package/app-text/pandoc

328+[gentoo]: http://packages.gentoo.org/package/app-text/pandoc

409329[haskell repository]: https://wiki.archlinux.org/index.php/Haskell_Package_Guidelines#.5Bhaskell.5D

410330[openSUSE]: https://software.opensuse.org/package/pandoc

411−[source tarball]: https://hackage.haskell.org/package/pandoc

412−[stack]: https://docs.haskellstack.org/en/stable/install_and_upgrade.html

413−[cabal-install]: https://hackage.haskell.org/package/cabal-install

414−[Void]: https://voidlinux.org/

331+[source tarball]: http://hackage.haskell.org/package/pandoc

332+[stack]: http://docs.haskellstack.org/en/stable/install_and_upgrade.html

333+[cabal-install]: http://hackage.haskell.org/trac/hackage/wiki/CabalInstall

415334[uninstaller]: https://raw.githubusercontent.com/jgm/pandoc/master/macos/uninstall-pandoc.pl

MANUAL.txt+2538−4559

@@ -1,34 +1,50 @@

1−---

2−title: Pandoc User's Guide

3−author: John MacFarlane

4−date: June 20, 2021

5−---

1+% Pandoc User's Guide

2+% John MacFarlane

3+% December 27, 2017

64

7−# Synopsis

5+Synopsis

6+========

87

98`pandoc` [*options*] [*input-file*]...

109

11−# Description

10+Description

11+===========

1212

1313Pandoc is a [Haskell] library for converting from one markup format to

14−another, and a command-line tool that uses this library.

15−

16−Pandoc can convert between numerous markup and word processing formats,

17−including, but not limited to, various flavors of [Markdown], [HTML],

18−[LaTeX] and [Word docx]. For the full lists of input and output formats,

19−see the `--from` and `--to` [options below][General options].

20−Pandoc can also produce [PDF] output: see [creating a PDF], below.

21−

22−Pandoc's enhanced version of Markdown includes syntax for [tables],

23−[definition lists], [metadata blocks], [footnotes], [citations], [math],

24−and much more. See below under [Pandoc's Markdown].

25−

26−Pandoc has a modular design: it consists of a set of readers, which parse

27−text in a given format and produce a native representation of the document

28−(an _abstract syntax tree_ or AST), and a set of writers, which convert

14+another, and a command-line tool that uses this library. It can read

15+[Markdown], [CommonMark], [PHP Markdown Extra], [GitHub-Flavored

16+Markdown], [MultiMarkdown], and (subsets of) [Textile],

17+[reStructuredText], [HTML], [LaTeX], [MediaWiki markup], [TWiki

18+markup], [TikiWiki markup], [Creole 1.0], [Haddock markup], [OPML],

19+[Emacs Org mode], [DocBook], [JATS], [Muse], [txt2tags], [Vimwiki],

20+[EPUB], [ODT], and [Word docx]; and it can write plain text, [Markdown],

21+[CommonMark], [PHP Markdown Extra], [GitHub-Flavored Markdown],

22+[MultiMarkdown], [reStructuredText], [XHTML], [HTML5], [LaTeX]

23+\(including [`beamer`] slide shows\), [ConTeXt], [RTF], [OPML],

24+[DocBook], [JATS], [OpenDocument], [ODT], [Word docx], [GNU Texinfo],

25+[MediaWiki markup], [DokuWiki markup], [ZimWiki markup], [Haddock

26+markup], [EPUB] \(v2 or v3\), [FictionBook2], [Textile], [groff man],

27+[groff ms], [Emacs Org mode], [AsciiDoc], [InDesign ICML], [TEI

28+Simple], [Muse], [PowerPoint] slide shows and [Slidy], [Slideous],

29+[DZSlides], [reveal.js] or [S5] HTML slide shows. It can also produce

30+[PDF] output on systems where LaTeX, ConTeXt, `pdfroff`,

31+`wkhtmltopdf`, `prince`, or `weasyprint` is installed.

32+

33+Pandoc's enhanced version of Markdown includes syntax for [footnotes],

34+[tables], flexible [ordered lists], [definition lists], [fenced code

35+blocks], [superscripts and subscripts], [strikeout], [metadata blocks],

36+automatic tables of contents, embedded LaTeX [math], [citations], and

37+[Markdown inside HTML block elements][Extension:

38+`markdown_in_html_blocks`]. (These enhancements, described further under

39+[Pandoc's Markdown], can be disabled using the `markdown_strict` input

40+or output format.)

41+

42+In contrast to most existing tools for converting Markdown to HTML, which

43+use regex substitutions, pandoc has a modular design: it consists of a

44+set of readers, which parse text in a given format and produce a native

45+representation of the document, and a set of writers, which convert

2946this native representation into a target format. Thus, adding an input

30−or output format requires only adding a reader or writer. Users can also

31−run custom [pandoc filters] to modify the intermediate AST.

47+or output format requires only adding a reader or writer.

3248

3349Because pandoc's intermediate representation of a document is less

3450expressive than many of the formats it converts between, one should

@@ -40,33 +56,98 @@ model. While conversions from pandoc's Markdown to all formats aspire

4056to be perfect, conversions from formats more expressive than pandoc's

4157Markdown can be expected to be lossy.

4258

43−## Using pandoc

59+[Markdown]: http://daringfireball.net/projects/markdown/

60+[CommonMark]: http://commonmark.org

61+[PHP Markdown Extra]: https://michelf.ca/projects/php-markdown/extra/

62+[GitHub-Flavored Markdown]: https://help.github.com/articles/github-flavored-markdown/

63+[MultiMarkdown]: http://fletcherpenney.net/multimarkdown/

64+[reStructuredText]: http://docutils.sourceforge.net/docs/ref/rst/introduction.html

65+[S5]: http://meyerweb.com/eric/tools/s5/

66+[Slidy]: http://www.w3.org/Talks/Tools/Slidy/

67+[Slideous]: http://goessner.net/articles/slideous/

68+[HTML]: http://www.w3.org/html/

69+[HTML5]: http://www.w3.org/TR/html5/

70+[polyglot markup]: https://www.w3.org/TR/html-polyglot/

71+[XHTML]: http://www.w3.org/TR/xhtml1/

72+[LaTeX]: http://latex-project.org

73+[`beamer`]: https://ctan.org/pkg/beamer

74+[Beamer User's Guide]: http://ctan.math.utah.edu/ctan/tex-archive/macros/latex/contrib/beamer/doc/beameruserguide.pdf

75+[ConTeXt]: http://www.contextgarden.net/

76+[RTF]: http://en.wikipedia.org/wiki/Rich_Text_Format

77+[DocBook]: http://docbook.org

78+[JATS]: https://jats.nlm.nih.gov

79+[txt2tags]: http://txt2tags.org

80+[EPUB]: http://idpf.org/epub

81+[OPML]: http://dev.opml.org/spec2.html

82+[OpenDocument]: http://opendocument.xml.org

83+[ODT]: http://en.wikipedia.org/wiki/OpenDocument

84+[Textile]: http://redcloth.org/textile

85+[MediaWiki markup]: https://www.mediawiki.org/wiki/Help:Formatting

86+[DokuWiki markup]: https://www.dokuwiki.org/dokuwiki

87+[ZimWiki markup]: http://zim-wiki.org/manual/Help/Wiki_Syntax.html

88+[TWiki markup]: http://twiki.org/cgi-bin/view/TWiki/TextFormattingRules

89+[TikiWiki markup]: https://doc.tiki.org/Wiki-Syntax-Text#The_Markup_Language_Wiki-Syntax

90+[Haddock markup]: https://www.haskell.org/haddock/doc/html/ch03s08.html

91+[Creole 1.0]: http://www.wikicreole.org/wiki/Creole1.0

92+[groff man]: http://man7.org/linux/man-pages/man7/groff_man.7.html

93+[groff ms]: http://man7.org/linux/man-pages/man7/groff_ms.7.html

94+[Haskell]: https://www.haskell.org

95+[GNU Texinfo]: http://www.gnu.org/software/texinfo/

96+[Emacs Org mode]: http://orgmode.org

97+[AsciiDoc]: http://www.methods.co.nz/asciidoc/

98+[DZSlides]: http://paulrouget.com/dzslides/

99+[Word docx]: https://en.wikipedia.org/wiki/Office_Open_XML

100+[PDF]: https://www.adobe.com/pdf/

101+[reveal.js]: http://lab.hakim.se/reveal-js/

102+[FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1

103+[InDesign ICML]: https://www.adobe.com/content/dam/Adobe/en/devnet/indesign/cs55-docs/IDML/idml-specification.pdf

104+[TEI Simple]: https://github.com/TEIC/TEI-Simple

105+[Muse]: https://amusewiki.org/library/manual

106+[PowerPoint]: https://en.wikipedia.org/wiki/Microsoft_PowerPoint

107+[Vimwiki]: https://vimwiki.github.io

108+

109+Using `pandoc`

110+--------------

44111

45−If no *input-files* are specified, input is read from *stdin*.

46−Output goes to *stdout* by default. For output to a file,

47−use the `-o` option:

112+If no *input-file* is specified, input is read from *stdin*.

113+Otherwise, the *input-files* are concatenated (with a blank

114+line between each) and used as input. Output goes to *stdout* by

115+default (though output to the terminal is disabled for the

116+`odt`, `docx`, `epub2`, and `epub3` output formats, unless it is

117+forced using `-o -`). For output to a file, use the `-o`

118+option:

48119

49120 pandoc -o output.html input.txt

50121

51−By default, pandoc produces a document fragment. To produce a standalone

52−document (e.g. a valid HTML file including `<head>` and `<body>`),

53−use the `-s` or `--standalone` flag:

122+By default, pandoc produces a document fragment, not a standalone

123+document with a proper header and footer. To produce a standalone

124+document, use the `-s` or `--standalone` flag:

54125

55126 pandoc -s -o output.html input.txt

56127

57128For more information on how standalone documents are produced, see

58−[Templates] below.

129+[Templates], below.

59130

60−If multiple input files are given, `pandoc` will concatenate them all (with

61−blank lines between them) before parsing. (Use `--file-scope` to parse files

62−individually.)

131+Instead of a file, an absolute URI may be given. In this case

132+pandoc will fetch the content using HTTP:

133+

134+ pandoc -f html -t markdown http://www.fsf.org

135+

136+It is possible to supply a custom User-Agent string or other

137+header when requesting a document from a URL:

138+

139+ pandoc -f html -t markdown --request-header User-Agent:"Mozilla/5.0" \

140+ http://www.fsf.org

63141

64−## Specifying formats

142+If multiple input files are given, `pandoc` will concatenate them all (with

143+blank lines between them) before parsing. This feature is disabled for

144+ binary input formats such as `EPUB`, `odt`, and `docx`.

65145

66146The format of the input and output can be specified explicitly using

67147command-line options. The input format can be specified using the

68−`-f/--from` option, the output format using the `-t/--to` option.

69−Thus, to convert `hello.txt` from Markdown to LaTeX, you could type:

148+`-r/--read` or `-f/--from` options, the output format using the

149+`-w/--write` or `-t/--to` options. Thus, to convert `hello.txt` from

150+Markdown to LaTeX, you could type:

70151

71152 pandoc -f markdown -t latex hello.txt

72153

@@ -74,15 +155,14 @@ To convert `hello.html` from HTML to Markdown:

74155

75156 pandoc -f html -t markdown hello.html

76157

77−Supported input and output formats are listed below under [Options]

78−(see `-f` for input formats and `-t` for output formats). You

79−can also use `pandoc --list-input-formats` and

80−`pandoc --list-output-formats` to print lists of supported

81−formats.

158+Supported output formats are listed below under the `-t/--to` option.

159+Supported input formats are listed below under the `-f/--from` option. Note

160+that the `rst`, `textile`, `latex`, and `html` readers are not complete;

161+there are some constructs that they do not parse.

82162

83163If the input or output format is not specified explicitly, `pandoc`

84−will attempt to guess it from the extensions of the filenames.

85−Thus, for example,

164+will attempt to guess it from the extensions of

165+the input and output filenames. Thus, for example,

86166

87167 pandoc -o hello.tex hello.txt

88168

@@ -91,9 +171,7 @@ is specified (so that output goes to *stdout*), or if the output file's

91171extension is unknown, the output format will default to HTML.

92172If no input file is specified (so that input comes from *stdin*), or

93173if the input files' extensions are unknown, the input format will

94−be assumed to be Markdown.

95−

96−## Character encoding

174+be assumed to be Markdown unless explicitly specified.

97175

98176Pandoc uses the UTF-8 character encoding for both input and output.

99177If your local character encoding is not UTF-8, you

@@ -106,167 +184,106 @@ RTF, OPML, DocBook, and Texinfo), information about

106184the character encoding is included in the document header, which

107185will only be included if you use the `-s/--standalone` option.

108186

109−[`iconv`]: https://www.gnu.org/software/libiconv/

187+[`iconv`]: http://www.gnu.org/software/libiconv/

110188

111−## Creating a PDF

189+Creating a PDF

190+--------------

112191

113−To produce a PDF, specify an output file with a `.pdf` extension:

192+To produce a PDF, specify an output file with a `.pdf` extension.

193+By default, pandoc will use LaTeX to create the PDF:

114194

115195 pandoc test.txt -o test.pdf

116196

117−By default, pandoc will use LaTeX to create the PDF, which requires

118−that a LaTeX engine be installed (see `--pdf-engine` below).

119−Alternatively, pandoc can use ConTeXt, roff ms, or HTML as an

120−intermediate format. To do this, specify an output file with a

121−`.pdf` extension, as before, but add the `--pdf-engine` option

122−or `-t context`, `-t html`, or `-t ms` to the command line.

123−The tool used to generate the PDF from the intermediate format

124−may be specified using `--pdf-engine`.

125−

126−You can control the PDF style using variables, depending on

127−the intermediate format used: see [variables for LaTeX],

128−[variables for ConTeXt], [variables for `wkhtmltopdf`],

129−[variables for ms]. When HTML is used as an intermediate

130−format, the output can be styled using `--css`.

131−

132−To debug the PDF creation, it can be useful to look at the intermediate

133−representation: instead of `-o test.pdf`, use for example `-s -o test.tex`

134−to output the generated LaTeX. You can then test it with `pdflatex test.tex`.

135−

136−When using LaTeX, the following packages need to be available

137−(they are included with all recent versions of [TeX Live]):

138−[`amsfonts`], [`amsmath`], [`lm`], [`unicode-math`],

139−[`iftex`], [`listings`] (if the

197+Production of a PDF requires that a LaTeX engine be installed (see

198+`--pdf-engine`, below), and assumes that the following LaTeX packages

199+are available: [`amsfonts`], [`amsmath`], [`lm`], [`unicode-math`],

200+[`ifxetex`], [`ifluatex`], [`listings`] (if the

140201`--listings` option is used), [`fancyvrb`], [`longtable`],

141−[`booktabs`], [`graphicx`] (if the document

142−contains images), [`hyperref`], [`xcolor`],

143−[`ulem`], [`geometry`] (with the `geometry` variable set),

144−[`setspace`] (with `linestretch`), and

202+[`booktabs`], [`graphicx`] and [`grffile`] (if the document

203+contains images), [`hyperref`], [`xcolor`] (with `colorlinks`), [`ulem`], [`geometry`] (with the

204+`geometry` variable set), [`setspace`] (with `linestretch`), and

145205[`babel`] (with `lang`). The use of `xelatex` or `lualatex` as

146−the PDF engine requires [`fontspec`]. `lualatex` uses

147−[`selnolig`]. `xelatex` uses [`polyglossia`] (with `lang`),

148−[`xecjk`], and [`bidi`] (with the `dir` variable set). If the

149−`mathspec` variable is set, `xelatex` will use [`mathspec`]

150−instead of [`unicode-math`]. The [`upquote`] and [`microtype`]

151−packages are used if available, and [`csquotes`] will be used

152−for [typography] if the `csquotes` variable or metadata field is

153−set to a true value. The [`natbib`], [`biblatex`], [`bibtex`],

154−and [`biber`] packages can optionally be used for [citation

155−rendering]. The following packages will be used to improve

156−output quality if present, but pandoc does not require them to

157−be present: [`upquote`] (for straight quotes in verbatim

158−environments), [`microtype`] (for better spacing adjustments),

159−[`parskip`] (for better inter-paragraph spaces), [`xurl`] (for

160−better line breaks in URLs), [`bookmark`] (for better PDF

161−bookmarks), and [`footnotehyper`] or [`footnote`] (to allow

162−footnotes in tables).

163−

164−[TeX Live]: https://www.tug.org/texlive/

206+the LaTeX engine requires [`fontspec`]. `xelatex` uses

207+[`polyglossia`] (with `lang`), [`xecjk`], and [`bidi`] (with the

208+`dir` variable set). If the `mathspec` variable is set,

209+`xelatex` will use [`mathspec`] instead of [`unicode-math`].

210+The [`upquote`] and [`microtype`] packages are used if

211+available, and [`csquotes`] will be used for [typography]

212+if added to the template or included in any header file. The

213+[`natbib`], [`biblatex`], [`bibtex`], and [`biber`] packages can

214+optionally be used for [citation rendering]. These are included

215+with all recent versions of [TeX Live].

216+

217+Alternatively, pandoc can use [ConTeXt], `pdfroff`, or any of the

218+following HTML/CSS-to-PDF-engines, to create a PDF: [`wkhtmltopdf`],

219+[`weasyprint`] or [`prince`].

220+To do this, specify an output file with a `.pdf` extension, as before,

221+but add the `--pdf-engine` option or `-t context`, `-t html`, or `-t ms`

222+to the command line (`-t html` defaults to `--pdf-engine=wkhtmltopdf`).

223+

224+PDF output can be controlled using [variables for LaTeX] (if

225+LaTeX is used) and [variables for ConTeXt] (if ConTeXt is used).

226+When using an HTML/CSS-to-PDF-engine, `--css` affects the output.

227+If `wkhtmltopdf` is used, then the variables `margin-left`,

228+`margin-right`, `margin-top`, `margin-bottom`, and `papersize`

229+will affect the output.

230+

165231[`amsfonts`]: https://ctan.org/pkg/amsfonts

166232[`amsmath`]: https://ctan.org/pkg/amsmath

167−[`babel`]: https://ctan.org/pkg/babel

168−[`biber`]: https://ctan.org/pkg/biber

169−[`biblatex`]: https://ctan.org/pkg/biblatex

170−[`bibtex`]: https://ctan.org/pkg/bibtex

171−[`bidi`]: https://ctan.org/pkg/bidi

172−[`bookmark`]: https://ctan.org/pkg/bookmark

173−[`booktabs`]: https://ctan.org/pkg/booktabs

174−[`csquotes`]: https://ctan.org/pkg/csquotes

233+[`lm`]: https://ctan.org/pkg/lm

234+[`ifxetex`]: https://ctan.org/pkg/ifxetex

235+[`ifluatex`]: https://ctan.org/pkg/ifluatex

236+[`listings`]: https://ctan.org/pkg/listings

175237[`fancyvrb`]: https://ctan.org/pkg/fancyvrb

176−[`fontspec`]: https://ctan.org/pkg/fontspec

177−[`footnote`]: https://ctan.org/pkg/footnote

178−[`footnotehyper`]: https://ctan.org/pkg/footnotehyper

179−[`geometry`]: https://ctan.org/pkg/geometry

238+[`longtable`]: https://ctan.org/pkg/longtable

239+[`booktabs`]: https://ctan.org/pkg/booktabs

180240[`graphicx`]: https://ctan.org/pkg/graphicx

181241[`grffile`]: https://ctan.org/pkg/grffile

182−[`hyperref`]: https://ctan.org/pkg/hyperref

183−[`iftex`]: https://ctan.org/pkg/iftex

184−[`listings`]: https://ctan.org/pkg/listings

185−[`lm`]: https://ctan.org/pkg/lm

186−[`longtable`]: https://ctan.org/pkg/longtable

187−[`mathspec`]: https://ctan.org/pkg/mathspec

188−[`microtype`]: https://ctan.org/pkg/microtype

189−[`natbib`]: https://ctan.org/pkg/natbib

190−[`parskip`]: https://ctan.org/pkg/parskip

191−[`polyglossia`]: https://ctan.org/pkg/polyglossia

192−[`prince`]: https://www.princexml.com/

242+[`geometry`]: https://ctan.org/pkg/geometry

193243[`setspace`]: https://ctan.org/pkg/setspace

244+[`xecjk`]: https://ctan.org/pkg/xecjk

245+[`hyperref`]: https://ctan.org/pkg/hyperref

194246[`ulem`]: https://ctan.org/pkg/ulem

247+[`babel`]: https://ctan.org/pkg/babel

248+[`bidi`]: https://ctan.org/pkg/bidi

249+[`mathspec`]: https://ctan.org/pkg/mathspec

195250[`unicode-math`]: https://ctan.org/pkg/unicode-math

251+[`polyglossia`]: https://ctan.org/pkg/polyglossia

252+[`fontspec`]: https://ctan.org/pkg/fontspec

196253[`upquote`]: https://ctan.org/pkg/upquote

197−[`weasyprint`]: https://weasyprint.org

254+[`microtype`]: https://ctan.org/pkg/microtype

255+[`csquotes`]: https://ctan.org/pkg/csquotes

256+[`natbib`]: https://ctan.org/pkg/natbib

257+[`biblatex`]: https://ctan.org/pkg/biblatex

258+[`bibtex`]: https://ctan.org/pkg/bibtex

259+[`biber`]: https://ctan.org/pkg/biber

260+[TeX Live]: http://www.tug.org/texlive/

198261[`wkhtmltopdf`]: https://wkhtmltopdf.org

199−[`xcolor`]: https://ctan.org/pkg/xcolor

200−[`xecjk`]: https://ctan.org/pkg/xecjk

201−[`xurl`]: https://ctan.org/pkg/xurl

202−[`selnolig`]: https://ctan.org/pkg/selnolig

203−

204−

205−

206−## Reading from the Web

207−

208−Instead of an input file, an absolute URI may be given. In this case

209−pandoc will fetch the content using HTTP:

210−

211− pandoc -f html -t markdown https://www.fsf.org

212−

213−It is possible to supply a custom User-Agent string or other

214−header when requesting a document from a URL:

215−

216− pandoc -f html -t markdown --request-header User-Agent:"Mozilla/5.0" \

217− https://www.fsf.org

262+[`weasyprint`]: http://weasyprint.org

263+[`prince`]: https://www.princexml.com/

218264

219−# Options

265+Options

266+=======

220267

221−## General options {.options}

268+General options

269+---------------

222270

223271`-f` *FORMAT*, `-r` *FORMAT*, `--from=`*FORMAT*, `--read=`*FORMAT*

224272

225−: Specify input format. *FORMAT* can be:

226−

227− ::: {#input-formats}

228− - `bibtex` ([BibTeX] bibliography)

229− - `biblatex` ([BibLaTeX] bibliography)

230− - `commonmark` ([CommonMark] Markdown)

231− - `commonmark_x` ([CommonMark] Markdown with extensions)

232− - `creole` ([Creole 1.0])

233− - `csljson` ([CSL JSON] bibliography)

234− - `csv` ([CSV] table)

235− - `docbook` ([DocBook])

236− - `docx` ([Word docx])

237− - `dokuwiki` ([DokuWiki markup])

238− - `epub` ([EPUB])

239− - `fb2` ([FictionBook2] e-book)

240− - `gfm` ([GitHub-Flavored Markdown]),

241− or the deprecated and less accurate `markdown_github`;

242− use [`markdown_github`](#markdown-variants) only

243− if you need extensions not supported in [`gfm`](#markdown-variants).

244− - `haddock` ([Haddock markup])

245− - `html` ([HTML])

246− - `ipynb` ([Jupyter notebook])

247− - `jats` ([JATS] XML)

248− - `jira` ([Jira]/Confluence wiki markup)

249− - `json` (JSON version of native AST)

250− - `latex` ([LaTeX])

251− - `markdown` ([Pandoc's Markdown])

252− - `markdown_mmd` ([MultiMarkdown])

253− - `markdown_phpextra` ([PHP Markdown Extra])

254− - `markdown_strict` (original unextended [Markdown])

255− - `mediawiki` ([MediaWiki markup])

256− - `man` ([roff man])

257− - `muse` ([Muse])

258− - `native` (native Haskell)

259− - `odt` ([ODT])

260− - `opml` ([OPML])

261− - `org` ([Emacs Org mode])

262− - `rst` ([reStructuredText])

263− - `t2t` ([txt2tags])

264− - `textile` ([Textile])

265− - `tikiwiki` ([TikiWiki markup])

266− - `twiki` ([TWiki markup])

267− - `vimwiki` ([Vimwiki])

268− :::

269−

273+: Specify input format. *FORMAT* can be `native` (native Haskell),

274+ `json` (JSON version of native AST), `markdown` (pandoc's

275+ extended Markdown), `markdown_strict` (original unextended

276+ Markdown), `markdown_phpextra` (PHP Markdown Extra),

277+ `markdown_mmd` (MultiMarkdown), `gfm` (GitHub-Flavored Markdown),

278+ `commonmark` (CommonMark Markdown), `textile` (Textile), `rst`

279+ (reStructuredText), `html` (HTML), `docbook` (DocBook), `t2t`

280+ (txt2tags), `docx` (docx), `odt` (ODT), `epub` (EPUB), `opml` (OPML),

281+ `org` (Emacs Org mode), `mediawiki` (MediaWiki markup), `twiki` (TWiki

282+ markup), `tikiwiki` (TikiWiki markup), `creole` (Creole 1.0),

283+ `haddock` (Haddock markup), or `latex` (LaTeX).

284+ (`markdown_github` provides deprecated and less accurate support

285+ for Github-Flavored Markdown; please use `gfm` instead, unless you

286+ need to use extensions other than `smart`.)

270287 Extensions can be individually enabled or disabled by

271288 appending `+EXTENSION` or `-EXTENSION` to the format name.

272289 See [Extensions] below, for a list of extensions and

@@ -275,75 +292,35 @@ header when requesting a document from a URL:

275292

276293`-t` *FORMAT*, `-w` *FORMAT*, `--to=`*FORMAT*, `--write=`*FORMAT*

277294

278−: Specify output format. *FORMAT* can be:

279−

280− ::: {#output-formats}

281− - `asciidoc` ([AsciiDoc]) or `asciidoctor` ([AsciiDoctor])

282− - `beamer` ([LaTeX beamer][`beamer`] slide show)

283− - `bibtex` ([BibTeX] bibliography)

284− - `biblatex` ([BibLaTeX] bibliography)

285− - `commonmark` ([CommonMark] Markdown)

286− - `commonmark_x` ([CommonMark] Markdown with extensions)

287− - `context` ([ConTeXt])

288− - `csljson` ([CSL JSON] bibliography)

289− - `docbook` or `docbook4` ([DocBook] 4)

290− - `docbook5` (DocBook 5)

291− - `docx` ([Word docx])

292− - `dokuwiki` ([DokuWiki markup])

293− - `epub` or `epub3` ([EPUB] v3 book)

294− - `epub2` (EPUB v2)

295− - `fb2` ([FictionBook2] e-book)

296− - `gfm` ([GitHub-Flavored Markdown]),

297− or the deprecated and less accurate `markdown_github`;

298− use [`markdown_github`](#markdown-variants) only

299− if you need extensions not supported in [`gfm`](#markdown-variants).

300− - `haddock` ([Haddock markup])

301− - `html` or `html5` ([HTML], i.e. [HTML5]/XHTML [polyglot markup])

302− - `html4` ([XHTML] 1.0 Transitional)

303− - `icml` ([InDesign ICML])

304− - `ipynb` ([Jupyter notebook])

305− - `jats_archiving` ([JATS] XML, Archiving and Interchange Tag Set)

306− - `jats_articleauthoring` ([JATS] XML, Article Authoring Tag Set)

307− - `jats_publishing` ([JATS] XML, Journal Publishing Tag Set)

308− - `jats` (alias for `jats_archiving`)

309− - `jira` ([Jira]/Confluence wiki markup)

310− - `json` (JSON version of native AST)

311− - `latex` ([LaTeX])

312− - `man` ([roff man])

313− - `markdown` ([Pandoc's Markdown])

314− - `markdown_mmd` ([MultiMarkdown])

315− - `markdown_phpextra` ([PHP Markdown Extra])

316− - `markdown_strict` (original unextended [Markdown])

317− - `mediawiki` ([MediaWiki markup])

318− - `ms` ([roff ms])

319− - `muse` ([Muse]),

320− - `native` (native Haskell),

321− - `odt` ([OpenOffice text document][ODT])

322− - `opml` ([OPML])

323− - `opendocument` ([OpenDocument])

324− - `org` ([Emacs Org mode])

325− - `pdf` ([PDF])

326− - `plain` (plain text),

327− - `pptx` ([PowerPoint] slide show)

328− - `rst` ([reStructuredText])

329− - `rtf` ([Rich Text Format])

330− - `texinfo` ([GNU Texinfo])

331− - `textile` ([Textile])

332− - `slideous` ([Slideous] HTML and JavaScript slide show)

333− - `slidy` ([Slidy] HTML and JavaScript slide show)

334− - `dzslides` ([DZSlides] HTML5 + JavaScript slide show),

335− - `revealjs` ([reveal.js] HTML5 + JavaScript slide show)

336− - `s5` ([S5] HTML and JavaScript slide show)

337− - `tei` ([TEI Simple])

338− - `xwiki` ([XWiki markup])

339− - `zimwiki` ([ZimWiki markup])

340− - the path of a custom Lua writer, see [Custom writers] below

341− :::

342−

343− Note that `odt`, `docx`, `epub`, and `pdf` output will not be directed

344− to *stdout* unless forced with `-o -`.

345−

346− Extensions can be individually enabled or

295+: Specify output format. *FORMAT* can be `native` (native Haskell),

296+ `json` (JSON version of native AST), `plain` (plain text),

297+ `markdown` (pandoc's extended Markdown), `markdown_strict`

298+ (original unextended Markdown), `markdown_phpextra` (PHP Markdown

299+ Extra), `markdown_mmd` (MultiMarkdown), `gfm` (GitHub-Flavored

300+ Markdown), `commonmark` (CommonMark Markdown), `rst`

301+ (reStructuredText), `html4` (XHTML 1.0 Transitional), `html` or

302+ `html5` (HTML5/XHTML [polyglot markup]), `latex` (LaTeX), `beamer`

303+ (LaTeX beamer slide show), `context` (ConTeXt), `man` (groff man),

304+ `mediawiki` (MediaWiki markup), `dokuwiki` (DokuWiki markup),

305+ `zimwiki` (ZimWiki markup), `textile` (Textile), `org` (Emacs Org

306+ mode), `texinfo` (GNU Texinfo), `opml` (OPML), `docbook` or

307+ `docbook4` (DocBook 4), `docbook5` (DocBook 5), `jats` (JATS XML),

308+ `opendocument` (OpenDocument), `odt` (OpenOffice text document),

309+ `docx` (Word docx), `haddock` (Haddock markup), `rtf` (rich text

310+ format), `epub2` (EPUB v2 book), `epub` or `epub3` (EPUB v3),

311+ `fb2` (FictionBook2 e-book), `asciidoc` (AsciiDoc), `icml`

312+ (InDesign ICML), `tei` (TEI Simple), `slidy` (Slidy HTML and

313+ JavaScript slide show), `slideous` (Slideous HTML and JavaScript

314+ slide show), `dzslides` (DZSlides HTML5 + JavaScript slide show),

315+ `revealjs` (reveal.js HTML5 + JavaScript slide show), `s5` (S5

316+ HTML and JavaScript slide show), `pptx` (PowerPoint slide show) or

317+ the path of a custom lua writer (see [Custom writers],

318+ below). (`markdown_github` provides deprecated and less accurate

319+ support for Github-Flavored Markdown; please use `gfm` instead,

320+ unless you use extensions that do not work with `gfm`.) Note that

321+ `odt`, `epub`, and `epub3` output will not be directed to

322+ *stdout*; an output filename must be specified using the

323+ `-o/--output` option. Extensions can be individually enabled or

347324 disabled by appending `+EXTENSION` or `-EXTENSION` to the format

348325 name. See [Extensions] below, for a list of extensions and their

349326 names. See `--list-output-formats` and `--list-extensions`, below.

@@ -358,43 +335,35 @@ header when requesting a document from a URL:

358335

359336: Specify the user data directory to search for pandoc data files.

360337 If this option is not specified, the default user data directory

361− will be used. On \*nix and macOS systems this will be the `pandoc`

362− subdirectory of the XDG data directory (by default,

363− `$HOME/.local/share`, overridable by setting the `XDG_DATA_HOME`

364− environment variable). If that directory does not exist and

365− `$HOME/.pandoc` exists, it will be used (for backwards compatibility).

366− On Windows the default user data directory is

367− `C:\Users\USERNAME\AppData\Roaming\pandoc`.

338+ will be used. This is, in UNIX:

339+

340+ $HOME/.pandoc

341+

342+ in Windows XP:

343+

344+ C:\Documents And Settings\USERNAME\Application Data\pandoc

345+

346+ and in Windows Vista or later:

347+

348+ C:\Users\USERNAME\AppData\Roaming\pandoc

349+

368350 You can find the default user data directory on your system by

369351 looking at the output of `pandoc --version`.

370− Data files placed in this directory (for example, `reference.odt`,

371− `reference.docx`, `epub.css`, `templates`) will override

372− pandoc's normal defaults.

373−

374−`-d` *FILE*, `--defaults=`*FILE*

375−

376−: Specify a set of default option settings. *FILE* is a YAML

377− file whose fields correspond to command-line option

378− settings. All options for document conversion, including input

379− and output files, can be set using a defaults file. The file will

380− be searched for first in the working directory, and then in

381− the `defaults` subdirectory of the user data directory

382− (see `--data-dir`). The `.yaml` extension may be omitted.

383− See the section [Default files] for more information on the

384− file format. Settings from the defaults file may be

385− overridden or extended by subsequent options on the command

386− line.

352+ A `reference.odt`, `reference.docx`, `epub.css`, `templates`,

353+ `slidy`, `slideous`, or `s5` directory

354+ placed in this directory will override pandoc's normal defaults.

387355

388356`--bash-completion`

389357

390358: Generate a bash completion script. To enable bash completion

391359 with pandoc, add this to your `.bashrc`:

392360

393− eval "$(pandoc --bash-completion)"

361+ eval "$(pandoc --bash-completion)"

394362

395363`--verbose`

396364

397−: Give verbose debugging output.

365+: Give verbose debugging output. Currently this only has an effect

366+ with PDF output.

398367

399368`--quiet`

400369

@@ -420,7 +389,7 @@ header when requesting a document from a URL:

420389

421390`--list-extensions`[`=`*FORMAT*]

422391

423−: List supported extensions for *FORMAT*, one per line, preceded

392+: List supported Markdown extensions, one per line, preceded

424393 by a `+` or `-` indicating whether it is enabled by default

425394 in *FORMAT*. If *FORMAT* is not specified, defaults for

426395 pandoc's Markdown are given.

@@ -443,88 +412,12 @@ header when requesting a document from a URL:

443412

444413: Show usage message.

445414

446−[Markdown]: https://daringfireball.net/projects/markdown/

447−[CommonMark]: https://commonmark.org

448−[PHP Markdown Extra]: https://michelf.ca/projects/php-markdown/extra/

449−[GitHub-Flavored Markdown]: https://help.github.com/articles/github-flavored-markdown/

450−[MultiMarkdown]: https://fletcherpenney.net/multimarkdown/

451−[reStructuredText]: https://docutils.sourceforge.io/docs/ref/rst/introduction.html

452−[S5]: https://meyerweb.com/eric/tools/s5/

453−[Slidy]: https://www.w3.org/Talks/Tools/Slidy2/

454−[Slideous]: https://goessner.net/articles/slideous/

455−[HTML]: https://www.w3.org/html/

456−[HTML5]: https://html.spec.whatwg.org/

457−[polyglot markup]: https://www.w3.org/TR/html-polyglot/

458−[XHTML]: https://www.w3.org/TR/xhtml1/

459−[LaTeX]: https://www.latex-project.org/

460−[`beamer`]: https://ctan.org/pkg/beamer

461−[Beamer User's Guide]: http://mirrors.ctan.org/macros/latex/contrib/beamer/doc/beameruserguide.pdf

462−[ConTeXt]: https://www.contextgarden.net/

463−[Rich Text Format]: https://en.wikipedia.org/wiki/Rich_Text_Format

464−[DocBook]: https://docbook.org

465−[JATS]: https://jats.nlm.nih.gov

466−[Jira]: https://jira.atlassian.com/secure/WikiRendererHelpAction.jspa?section=all

467−[txt2tags]: https://txt2tags.org

468−[EPUB]: http://idpf.org/epub

469−[OPML]: http://dev.opml.org/spec2.html

470−[OpenDocument]: http://opendocument.xml.org

471−[ODT]: https://en.wikipedia.org/wiki/OpenDocument

472−[Textile]: https://www.promptworks.com/textile

473−[MediaWiki markup]: https://www.mediawiki.org/wiki/Help:Formatting

474−[DokuWiki markup]: https://www.dokuwiki.org/dokuwiki

475−[ZimWiki markup]: https://zim-wiki.org/manual/Help/Wiki_Syntax.html

476−[XWiki markup]: https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/XWikiSyntax/

477−[TWiki markup]: https://twiki.org/cgi-bin/view/TWiki/TextFormattingRules

478−[TikiWiki markup]: https://doc.tiki.org/Wiki-Syntax-Text#The_Markup_Language_Wiki-Syntax

479−[Haddock markup]: https://www.haskell.org/haddock/doc/html/ch03s08.html

480−[Creole 1.0]: http://www.wikicreole.org/wiki/Creole1.0

481−[CSV]: https://tools.ietf.org/html/rfc4180

482−[roff man]: https://man.cx/groff_man(7)

483−[roff ms]: https://man.cx/groff_ms(7)

484−[Haskell]: https://www.haskell.org

485−[GNU Texinfo]: https://www.gnu.org/software/texinfo/

486−[Emacs Org mode]: https://orgmode.org

487−[AsciiDoc]: https://www.methods.co.nz/asciidoc/

488−[AsciiDoctor]: https://asciidoctor.org/

489−[DZSlides]: https://paulrouget.com/dzslides/

490−[Word docx]: https://en.wikipedia.org/wiki/Office_Open_XML

491−[PDF]: https://www.adobe.com/pdf/

492−[reveal.js]: https://revealjs.com/

493−[FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1

494−[Jupyter notebook]: https://nbformat.readthedocs.io/en/latest/

495−[InDesign ICML]: https://wwwimages.adobe.com/www.adobe.com/content/dam/acom/en/devnet/indesign/sdk/cs6/idml/idml-cookbook.pdf

496−[TEI Simple]: https://github.com/TEIC/TEI-Simple

497−[Muse]: https://amusewiki.org/library/manual

498−[PowerPoint]: https://en.wikipedia.org/wiki/Microsoft_PowerPoint

499−[Vimwiki]: https://vimwiki.github.io

500−[CSL JSON]: https://citeproc-js.readthedocs.io/en/latest/csl-json/markup.html

501−[BibTeX]: https://ctan.org/pkg/bibtex

502−[BibLaTeX]: https://ctan.org/pkg/biblatex

503−

504−## Reader options {.options}

505−

506−`--shift-heading-level-by=`*NUMBER*

507−

508−: Shift heading levels by a positive or negative integer.

509− For example, with `--shift-heading-level-by=-1`, level 2

510− headings become level 1 headings, and level 3 headings

511− become level 2 headings. Headings cannot have a level

512− less than 1, so a heading that would be shifted below level 1

513− becomes a regular paragraph. Exception: with a shift of -N,

514− a level-N heading at the beginning of the document

515− replaces the metadata title. `--shift-heading-level-by=-1`

516− is a good choice when converting HTML or Markdown documents that

517− use an initial level-1 heading for the document title and

518− level-2+ headings for sections. `--shift-heading-level-by=1`

519− may be a good choice for converting Markdown documents that

520− use level-1 headings for sections to HTML, since pandoc uses

521− a level-1 heading to render the document title.

415+Reader options

416+--------------

522417

523418`--base-header-level=`*NUMBER*

524419

525−: *Deprecated. Use `--shift-heading-level-by`=X instead,

526− where X = NUMBER - 1.* Specify the base level for headings

527− (defaults to 1).

420+: Specify the base level for headers (defaults to 1).

528421

529422`--strip-empty-paragraphs`

530423

@@ -554,7 +447,7 @@ header when requesting a document from a URL:

554447 footnotes and links will not work across files. Reading binary

555448 files (docx, odt, epub) implies `--file-scope`.

556449

557−`-F` *PROGRAM*, `--filter=`*PROGRAM*

450+`--filter=`*PROGRAM*

558451

559452: Specify an executable to be used as a filter transforming the

560453 pandoc AST after the input is parsed and before the output is

@@ -589,65 +482,47 @@ header when requesting a document from a URL:

589482

590483 3. `$PATH` (executable only)

591484

592− Filters, Lua-filters, and citeproc processing are applied in

593− the order specified on the command line.

594−

595−`-L` *SCRIPT*, `--lua-filter=`*SCRIPT*

485+`--lua-filter=`*SCRIPT*

596486

597487: Transform the document in a similar fashion as JSON filters (see

598− `--filter`), but use pandoc's built-in Lua filtering system. The given

599− Lua script is expected to return a list of Lua filters which will be

600− applied in order. Each Lua filter must contain element-transforming

488+ `--filter`), but use pandoc's build-in lua filtering system. The given

489+ lua script is expected to return a list of lua filters which will be

490+ applied in order. Each lua filter must contain element-transforming

601491 functions indexed by the name of the AST element on which the filter

602492 function should be applied.

603493

604− The `pandoc` Lua module provides helper functions for element

605− creation. It is always loaded into the script's Lua environment.

606−

607− See the [Lua filters documentation] for further details.

494+ The `pandoc` lua module provides helper functions for element

495+ creation. It is always loaded into the script's lua environment.

608496

609− In order of preference, pandoc will look for Lua filters in

497+ The following is an example lua script for macro-expansion:

610498

611− 1. a specified full or relative path

499+ function expand_hello_world(inline)

500+ if inline.c == '{{helloworld}}' then

501+ return pandoc.Emph{ pandoc.Str "Hello, World" }

502+ else

503+ return inline

504+ end

505+ end

612506

613− 2. `$DATADIR/filters` where `$DATADIR` is the user data

614− directory (see `--data-dir`, above).

507+ return {{Str = expand_hello_world}}

615508

616− Filters, Lua filters, and citeproc processing are applied in

617− the order specified on the command line.

618509

619510`-M` *KEY*[`=`*VAL*], `--metadata=`*KEY*[`:`*VAL*]

620511

621512: Set the metadata field *KEY* to the value *VAL*. A value specified

622− on the command line overrides a value specified in the document

623− using [YAML metadata blocks][Extension: `yaml_metadata_block`].

513+ on the command line overrides a value specified in the document.

624514 Values will be parsed as YAML boolean or string values. If no value is

625515 specified, the value will be treated as Boolean true. Like

626516 `--variable`, `--metadata` causes template variables to be set.

627517 But unlike `--variable`, `--metadata` affects the metadata of the

628518 underlying document (which is accessible from filters and may be

629− printed in some output formats) and metadata values will be escaped

630− when inserted into the template.

631−

632−`--metadata-file=`*FILE*

633−

634−: Read metadata from the supplied YAML (or JSON) file. This

635− option can be used with every input format, but string scalars

636− in the YAML file will always be parsed as Markdown. Generally,

637− the input will be handled the same as in [YAML metadata

638− blocks][Extension: `yaml_metadata_block`]. This option can be

639− used repeatedly to include multiple metadata files; values in

640− files specified later on the command line will be preferred

641− over those specified in earlier files. Metadata values

642− specified inside the document, or by using `-M`, overwrite

643− values specified with this option.

519+ printed in some output formats).

644520

645521`-p`, `--preserve-tabs`

646522

647−: Preserve tabs instead of converting them to spaces. (By default, pandoc

648− converts tabs to spaces before parsing its input.) Note that this will

649− only affect tabs in literal code spans and code blocks. Tabs in regular

650− text are always treated as spaces.

523+: Preserve tabs instead of converting them to spaces (the default).

524+ Note that this will only affect tabs in literal code spans and code

525+ blocks; tabs in regular text will be treated as spaces.

651526

652527`--tab-stop=`*NUMBER*

653528

@@ -657,30 +532,27 @@ header when requesting a document from a URL:

657532

658533: Specifies what to do with insertions, deletions, and comments

659534 produced by the MS Word "Track Changes" feature. `accept` (the

660− default) processes all the insertions and deletions.

661− `reject` ignores them. Both `accept` and `reject` ignore comments.

662− `all` includes all insertions, deletions, and comments, wrapped

663− in spans with `insertion`, `deletion`, `comment-start`, and

664− `comment-end` classes, respectively. The author and time of

665− change is included. `all` is useful for scripting: only

666− accepting changes from a certain reviewer, say, or before a

667− certain date. If a paragraph is inserted or deleted,

668− `track-changes=all` produces a span with the class

669− `paragraph-insertion`/`paragraph-deletion` before the

670− affected paragraph break. This option only affects the docx

671− reader.

535+ default), inserts all insertions, and ignores all

536+ deletions. `reject` inserts all deletions and ignores

537+ insertions. Both `accept` and `reject` ignore comments. `all` puts

538+ in insertions, deletions, and comments, wrapped in spans with

539+ `insertion`, `deletion`, `comment-start`, and `comment-end`

540+ classes, respectively. The author and time of change is

541+ included. `all` is useful for scripting: only accepting changes

542+ from a certain reviewer, say, or before a certain date. This

543+ option only affects the docx reader.

672544

673545`--extract-media=`*DIR*

674546

675547: Extract images and other media contained in or linked from

676548 the source document to the path *DIR*, creating it if

677549 necessary, and adjust the images references in the document

678− so they point to the extracted files. Media are downloaded,

679− read from the file system, or extracted from a binary

680− container (e.g. docx), as needed. The original file paths

681− are used if they are relative paths not containing `..`.

682− Otherwise filenames are constructed from the SHA1 hash of

683− the contents.

550+ so they point to the extracted files. If the source format is

551+ a binary container (docx, epub, or odt), the media is

552+ extracted from the container and the original

553+ filenames are used. Otherwise the media is read from the

554+ file system or downloaded, and new filenames are constructed

555+ based on SHA1 hashes of the contents.

684556

685557`--abbreviations=`*FILE*

686558

@@ -691,30 +563,29 @@ header when requesting a document from a URL:

691563 system default, use

692564 `pandoc --print-default-data-file=abbreviations`. The only

693565 use pandoc makes of this list is in the Markdown reader.

694− Strings found in this list will be followed by a nonbreaking

695− space, and the period will not produce sentence-ending space

696− in formats like LaTeX. The strings may not contain spaces.

566+ Strings ending in a period that are found in this list will

567+ be followed by a nonbreaking space, so that the period will

568+ not produce sentence-ending space in formats like LaTeX.

697569

698570[`pandocfilters`]: https://github.com/jgm/pandocfilters

699571[PHP]: https://github.com/vinai/pandocfilters-php

700572[perl]: https://metacpan.org/pod/Pandoc::Filter

701573[JavaScript/node.js]: https://github.com/mvhenderson/pandoc-filter-node

702−[Lua filters documentation]: https://pandoc.org/lua-filters.html

703574

704−## General writer options {.options}

575+General writer options

576+----------------------

705577

706578`-s`, `--standalone`

707579

708580: Produce output with an appropriate header and footer (e.g. a

709581 standalone HTML, LaTeX, TEI, or RTF file, not a fragment). This option

710582 is set automatically for `pdf`, `epub`, `epub3`, `fb2`, `docx`, and `odt`

711− output. For `native` output, this option causes metadata to

712− be included; otherwise, metadata is suppressed.

583+ output.

713584

714−`--template=`*FILE*|*URL*

585+`--template=`*FILE*

715586

716−: Use the specified file as a custom template for the generated document.

717− Implies `--standalone`. See [Templates], below, for a description

587+: Use *FILE* as a custom template for the generated document. Implies

588+ `--standalone`. See [Templates], below, for a description

718589 of template syntax. If no extension is specified, an extension

719590 corresponding to the writer will be added, so that `--template=special`

720591 looks for `special.html` for HTML output. If the template is not

@@ -726,29 +597,22 @@ header when requesting a document from a URL:

726597`-V` *KEY*[`=`*VAL*], `--variable=`*KEY*[`:`*VAL*]

727598

728599: Set the template variable *KEY* to the value *VAL* when rendering the

729− document in standalone mode. If no *VAL* is specified, the

730− key will be given the value `true`.

600+ document in standalone mode. This is generally only useful when the

601+ `--template` option is used to specify a custom template, since

602+ pandoc automatically sets the variables used in the default

603+ templates. If no *VAL* is specified, the key will be given the

604+ value `true`.

731605

732606`-D` *FORMAT*, `--print-default-template=`*FORMAT*

733607

734608: Print the system default template for an output *FORMAT*. (See `-t`

735609 for a list of possible *FORMAT*s.) Templates in the user data

736− directory are ignored. This option may be used with

737− `-o`/`--output` to redirect output to a file, but

738− `-o`/`--output` must come before `--print-default-template`

739− on the command line.

740−

741− Note that some of the default templates use partials, for

742− example `styles.html`. To print the partials, use

743− `--print-default-data-file`: for example,

744− `--print-default-data-file=templates/styles.html`.

610+ directory are ignored.

745611

746612`--print-default-data-file=`*FILE*

747613

748614: Print a system default data file. Files in the user data directory

749− are ignored. This option may be used with `-o`/`--output` to

750− redirect output to a file, but `-o`/`--output` must come before

751− `--print-default-data-file` on the command line.

615+ are ignored.

752616

753617`--eol=crlf`|`lf`|`native`

754618

@@ -759,12 +623,9 @@ header when requesting a document from a URL:

759623

760624`--dpi`=*NUMBER*

761625

762−: Specify the default dpi (dots per inch) value for conversion

763− from pixels to inch/centimeters and vice versa. (Technically,

764− the correct term would be ppi: pixels per inch.) The default

765− is 96dpi. When images contain information about dpi

766− internally, the encoded value is used instead of the default

767− specified by this option.

626+: Specify the dpi (dots per inch) value for conversion from pixels

627+ to inch/centimeters and vice versa. The default is 96dpi.

628+ Technically, the correct term would be ppi (pixels per inch).

768629

769630`--wrap=auto`|`none`|`preserve`

770631

@@ -777,8 +638,6 @@ header when requesting a document from a URL:

777638 where there are nonsemantic newlines in the source, there

778639 will be nonsemantic newlines in the output as well).

779640 Automatic wrapping does not currently work in HTML output.

780− In `ipynb` output, this option affects wrapping of the

781− contents of markdown cells.

782641

783642`--columns=`*NUMBER*

784643

@@ -791,21 +650,14 @@ header when requesting a document from a URL:

791650: Include an automatically generated table of contents (or, in

792651 the case of `latex`, `context`, `docx`, `odt`,

793652 `opendocument`, `rst`, or `ms`, an instruction to create

794− one) in the output document. This option has no effect

795− unless `-s/--standalone` is used, and it has no effect

796− on `man`, `docbook4`, `docbook5`, or `jats` output.

797−

798− Note that if you are producing a PDF via `ms`, the table

799− of contents will appear at the beginning of the

800− document, before the title. If you would prefer it to

801− be at the end of the document, use the option

802− `--pdf-engine-opt=--no-toc-relocation`.

653+ one) in the output document. This option has no effect on

654+ `man`, `docbook4`, `docbook5`, or `jats` output.

803655

804656`--toc-depth=`*NUMBER*

805657

806658: Specify the number of section levels to include in the table

807− of contents. The default is 3 (which means that level-1, 2, and 3

808− headings will be listed in the contents).

659+ of contents. The default is 3 (which means that level 1, 2, and 3

660+ headers will be listed in the contents).

809661

810662`--strip-comments`

811663

@@ -841,10 +693,7 @@ header when requesting a document from a URL:

841693

842694: Prints a JSON version of a highlighting style, which can

843695 be modified, saved with a `.theme` extension, and used

844− with `--highlight-style`. This option may be used with

845− `-o`/`--output` to redirect output to a file, but

846− `-o`/`--output` must come before `--print-highlight-style`

847− on the command line.

696+ with `--highlight-style`.

848697

849698`--syntax-definition=`*FILE*

850699

@@ -852,10 +701,9 @@ header when requesting a document from a URL:

852701 which will be used for syntax highlighting of appropriately

853702 marked code blocks. This can be used to add support for

854703 new languages or to use altered syntax definitions for

855− existing languages. This option may be repeated to add

856− multiple syntax definitions.

704+ existing languages.

857705

858−`-H` *FILE*, `--include-in-header=`*FILE*|*URL*

706+`-H` *FILE*, `--include-in-header=`*FILE*

859707

860708: Include contents of *FILE*, verbatim, at the end of the header.

861709 This can be used, for example, to include special

@@ -863,7 +711,7 @@ header when requesting a document from a URL:

863711 repeatedly to include multiple files in the header. They will be

864712 included in the order specified. Implies `--standalone`.

865713

866−`-B` *FILE*, `--include-before-body=`*FILE*|*URL*

714+`-B` *FILE*, `--include-before-body=`*FILE*

867715

868716: Include contents of *FILE*, verbatim, at the beginning of the

869717 document body (e.g. after the `<body>` tag in HTML, or the

@@ -872,7 +720,7 @@ header when requesting a document from a URL:

872720 used repeatedly to include multiple files. They will be included in

873721 the order specified. Implies `--standalone`.

874722

875−`-A` *FILE*, `--include-after-body=`*FILE*|*URL*

723+`-A` *FILE*, `--include-after-body=`*FILE*

876724

877725: Include contents of *FILE*, verbatim, at the end of the document

878726 body (before the `</body>` tag in HTML, or the

@@ -891,39 +739,28 @@ header when requesting a document from a URL:

891739 will not be searched. For example:

892740 `--resource-path=.:test` will search the working directory

893741 and the `test` subdirectory, in that order.

894− This option can be used repeatedly. Search path components

895− that come later on the command line will be searched before

896− those that come earlier, so

897− `--resource-path foo:bar --resource-path baz:bim` is

898− equivalent to `--resource-path baz:bim:foo:bar`.

899742

900743`--request-header=`*NAME*`:`*VAL*

901744

902745: Set the request header *NAME* to the value *VAL* when making

903746 HTTP requests (for example, when a URL is given on the

904747 command line, or when resources used in a document must be

905− downloaded). If you're behind a proxy, you also need to set

906− the environment variable `http_proxy` to `http://...`.

748+ downloaded).

907749

908−`--no-check-certificate`

909−

910−: Disable the certificate verification to allow access to

911− unsecure HTTP resources (for example when the certificate

912− is no longer valid or self signed).

913−

914−## Options affecting specific writers {.options}

750+Options affecting specific writers

751+----------------------------------

915752

916753`--self-contained`

917754

918755: Produce a standalone HTML file with no external dependencies, using

919756 `data:` URIs to incorporate the contents of linked scripts, stylesheets,

920− images, and videos. Implies `--standalone`. The resulting file should be

921− "self-contained," in the sense that it needs no external files and no net

922− access to be displayed properly by a browser. This option works only with

923− HTML output formats, including `html4`, `html5`, `html+lhs`, `html5+lhs`,

924− `s5`, `slidy`, `slideous`, `dzslides`, and `revealjs`. Scripts, images,

925− and stylesheets at absolute URLs will be downloaded; those at relative

926− URLs will be sought relative to the working directory (if the first source

757+ images, and videos. The resulting file should be "self-contained,"

758+ in the sense that it needs no external files and no net access to be

759+ displayed properly by a browser. This option works only with HTML output

760+ formats, including `html4`, `html5`, `html+lhs`, `html5+lhs`, `s5`,

761+ `slidy`, `slideous`, `dzslides`, and `revealjs`. Scripts, images, and

762+ stylesheets at absolute URLs will be downloaded; those at relative URLs

763+ will be sought relative to the working directory (if the first source

927764 file is local) or relative to the base URL (if the first source

928765 file is remote). Elements with the attribute

929766 `data-external="1"` will be left alone; the documents they

@@ -936,18 +773,13 @@ header when requesting a document from a URL:

936773

937774`--html-q-tags`

938775

939−: Use `<q>` tags for quotes in HTML. (This option only has an

940− effect if the `smart` extension is enabled for the input

941− format used.)

776+: Use `<q>` tags for quotes in HTML.

942777

943778`--ascii`

944779

945−: Use only ASCII characters in output. Currently supported for XML

946− and HTML formats (which use entities instead of UTF-8 when this

947− option is selected), CommonMark, gfm, and Markdown (which use

948− entities), roff ms (which use hexadecimal escapes), and to a

949− limited degree LaTeX (which uses standard commands for accented

950− characters when possible). roff man output uses ASCII by default.

780+: Use only ASCII characters in output. Currently supported only for

781+ HTML and DocBook output (which uses numerical entities instead of

782+ UTF-8 when this option is selected).

951783

952784`--reference-links`

953785

@@ -956,45 +788,36 @@ header when requesting a document from a URL:

956788 placement of link references is affected by the

957789 `--reference-location` option.

958790

959−`--reference-location=block`|`section`|`document`

791+`--reference-location = block`|`section`|`document`

960792

961793: Specify whether footnotes (and references, if `reference-links` is

962794 set) are placed at the end of the current (top-level) block, the

963795 current section, or the document. The default is

964796 `document`. Currently only affects the markdown writer.

965797

966−`--markdown-headings=setext`|`atx`

967−

968−: Specify whether to use ATX-style (`#`-prefixed) or

969− Setext-style (underlined) headings for level 1 and 2

970− headings in Markdown output. (The default is `atx`.)

971− ATX-style headings are always used for levels 3+.

972− This option also affects Markdown cells in `ipynb` output.

973−

974798`--atx-headers`

975799

976−: *Deprecated synonym for `--markdown-headings=atx`.*

800+: Use ATX-style headers in Markdown and AsciiDoc output. The default is

801+ to use setext-style headers for levels 1-2, and then ATX headers.

802+ (Note: for `gfm` output, ATX headers are always used.)

977803

978−`--top-level-division=default`|`section`|`chapter`|`part`

804+`--top-level-division=[default|section|chapter|part]`

979805

980−: Treat top-level headings as the given division type in

981− LaTeX, ConTeXt, DocBook, and TEI output. The hierarchy

982− order is part, chapter, then section; all headings are

983− shifted such that the top-level heading becomes the

984− specified type. The default behavior is to determine the

985− best division type via heuristics: unless other conditions

986− apply, `section` is chosen. When the `documentclass`

987− variable is set to `report`, `book`, or `memoir` (unless the

988− `article` option is specified), `chapter` is implied as the

989− setting for this option. If `beamer` is the output format,

990− specifying either `chapter` or `part` will cause top-level

991− headings to become `\part{..}`, while second-level headings

992− remain as their default type.

806+: Treat top-level headers as the given division type in LaTeX, ConTeXt,

807+ DocBook, and TEI output. The hierarchy order is part, chapter, then section;

808+ all headers are shifted such that the top-level header becomes the specified

809+ type. The default behavior is to determine the best division type via

810+ heuristics: unless other conditions apply, `section` is chosen. When the

811+ LaTeX document class is set to `report`, `book`, or `memoir` (unless the

812+ `article` option is specified), `chapter` is implied as the setting for this

813+ option. If `beamer` is the output format, specifying either `chapter` or

814+ `part` will cause top-level headers to become `\part{..}`, while

815+ second-level headers remain as their default type.

993816

994817`-N`, `--number-sections`

995818

996−: Number section headings in LaTeX, ConTeXt, HTML, Docx, ms, or EPUB

997− output. By default, sections are not numbered. Sections with class

819+: Number section headings in LaTeX, ConTeXt, HTML, or EPUB output.

820+ By default, sections are not numbered. Sections with class

998821 `unnumbered` will never be numbered, even if `--number-sections`

999822 is specified.

1000823

@@ -1002,19 +825,16 @@ header when requesting a document from a URL:

1002825

1003826: Offset for section headings in HTML output (ignored in other

1004827 output formats). The first number is added to the section number for

1005− top-level headings, the second for second-level headings, and so on.

1006− So, for example, if you want the first top-level heading in your

828+ top-level headers, the second for second-level headers, and so on.

829+ So, for example, if you want the first top-level header in your

1007830 document to be numbered "6", specify `--number-offset=5`.

1008− If your document starts with a level-2 heading which you want to

831+ If your document starts with a level-2 header which you want to

1009832 be numbered "1.5", specify `--number-offset=1,4`.

1010833 Offsets are 0 by default. Implies `--number-sections`.

1011834

1012835`--listings`

1013836

1014−: Use the [`listings`] package for LaTeX code blocks. The package

1015− does not support multi-byte encoding for source code. To handle UTF-8

1016− you would need to use a custom template. This issue is fully

1017− documented here: [Encoding issue with the listings package].

837+: Use the [`listings`] package for LaTeX code blocks

1018838

1019839`-i`, `--incremental`

1020840

@@ -1023,12 +843,12 @@ header when requesting a document from a URL:

1023843

1024844`--slide-level=`*NUMBER*

1025845

1026−: Specifies that headings with the specified level create

1027− slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headings

846+: Specifies that headers with the specified level create

847+ slides (for `beamer`, `s5`, `slidy`, `slideous`, `dzslides`). Headers

1028848 above this level in the hierarchy are used to divide the

1029− slide show into sections; headings below this level create

849+ slide show into sections; headers below this level create

1030850 subheads within a slide. Note that content that is

1031− not contained under slide-level headings will not appear in

851+ not contained under slide-level headers will not appear in

1032852 the slide show. The default is to set the slide level based

1033853 on the contents of the document; see [Structuring the slide

1034854 show].

@@ -1037,8 +857,8 @@ header when requesting a document from a URL:

1037857

1038858: Wrap sections in `<section>` tags (or `<div>` tags for `html4`),

1039859 and attach identifiers to the enclosing `<section>` (or `<div>`)

1040− rather than the heading itself. See

1041− [Heading identifiers], below.

860+ rather than the header itself. See

861+ [Header identifiers], below.

1042862

1043863`--email-obfuscation=none`|`javascript`|`references`

1044864

@@ -1059,7 +879,8 @@ header when requesting a document from a URL:

1059879

1060880: Specify *STRING* as a prefix at the beginning of the title

1061881 that appears in the HTML header (but not in the title as it

1062− appears at the beginning of the HTML body). Implies `--standalone`.

882+ appears at the beginning of the HTML body). Implies

883+ `--standalone`.

1063884

1064885`-c` *URL*, `--css=`*URL*

1065886

@@ -1067,8 +888,8 @@ header when requesting a document from a URL:

1067888 include multiple files. They will be included in the order specified.

1068889

1069890 A stylesheet is required for generating EPUB. If none is

1070− provided using this option (or the `css` or `stylesheet`

1071− metadata fields), pandoc will look for a file `epub.css` in the

891+ provided using this option (or the `stylesheet` metadata

892+ field), pandoc will look for a file `epub.css` in the

1072893 user data directory (see `--data-dir`). If it is not

1073894 found there, sensible defaults will be used.

1074895

@@ -1091,56 +912,20 @@ header when requesting a document from a URL:

1091912

1092913 To produce a custom `reference.docx`, first get a copy of

1093914 the default `reference.docx`: `pandoc

1094− -o custom-reference.docx --print-default-data-file reference.docx`.

1095− Then open `custom-reference.docx` in Word, modify the

1096− styles as you wish, and save the file. For best

1097− results, do not make changes to this file other than

1098− modifying the styles used by pandoc:

1099−

1100− Paragraph styles:

1101−

1102− - Normal

1103− - Body Text

1104− - First Paragraph

1105− - Compact

1106− - Title

1107− - Subtitle

1108− - Author

1109− - Date

1110− - Abstract

1111− - Bibliography

1112− - Heading 1

1113− - Heading 2

1114− - Heading 3

1115− - Heading 4

1116− - Heading 5

1117− - Heading 6

1118− - Heading 7

1119− - Heading 8

1120− - Heading 9

1121− - Block Text

1122− - Footnote Text

1123− - Definition Term

1124− - Definition

1125− - Caption

1126− - Table Caption

1127− - Image Caption

1128− - Figure

1129− - Captioned Figure

1130− - TOC Heading

1131−

1132− Character styles:

1133−

1134− - Default Paragraph Font

1135− - Body Text Char

1136− - Verbatim Char

1137− - Footnote Reference

1138− - Hyperlink

1139− - Section Number

1140−

1141− Table style:

1142−

1143− - Table

915+ --print-default-data-file reference.docx >

916+ custom-reference.docx`. Then open `custom-reference.docx`

917+ in Word, modify the styles as you wish, and save the file.

918+ For best results, do not make changes to this file other

919+ than modifying the styles used by pandoc: [paragraph]

920+ Normal, Body Text, First Paragraph, Compact, Title,

921+ Subtitle, Author, Date, Abstract, Bibliography, Heading 1,

922+ Heading 2, Heading 3, Heading 4, Heading 5, Heading 6,

923+ Heading 7, Heading 8, Heading 9, Block Text, Footnote Text,

924+ Definition Term, Definition, Caption, Table Caption,

925+ Image Caption, Figure, Captioned Figure, TOC Heading;

926+ [character] Default Paragraph Font, Body Text Char,

927+ Verbatim Char, Footnote Reference, Hyperlink; [table]

928+ Table.

1144929

1145930 ODT

1146931

@@ -1154,33 +939,10 @@ header when requesting a document from a URL:

1154939

1155940 To produce a custom `reference.odt`, first get a copy of

1156941 the default `reference.odt`: `pandoc

1157− -o custom-reference.odt --print-default-data-file reference.odt`.

1158− Then open `custom-reference.odt` in LibreOffice, modify

1159− the styles as you wish, and save the file.

1160−

1161− PowerPoint

1162−

1163− : Templates included with Microsoft PowerPoint 2013 (either with

1164− `.pptx` or `.potx` extension) are known to work, as are most

1165− templates derived from these.

1166−

1167− The specific requirement is that the template should begin with

1168− the following first four layouts:

1169−

1170− 1. Title Slide

1171− 2. Title and Content

1172− 3. Section Header

1173− 4. Two Content

1174−

1175− All templates included with a recent version of MS PowerPoint

1176− will fit these criteria. (You can click on `Layout` under the

1177− `Home` menu to check.)

1178−

1179− You can also modify the default `reference.pptx`: first run

1180− `pandoc -o custom-reference.pptx --print-default-data-file

1181− reference.pptx`, and then modify `custom-reference.pptx`

1182− in MS PowerPoint (pandoc will use the first four layout

1183− slides, as mentioned above).

942+ --print-default-data-file reference.odt >

943+ custom-reference.odt`. Then open `custom-reference.odt` in

944+ LibreOffice, modify the styles as you wish, and save the

945+ file.

1184946

1185947`--epub-cover-image=`*FILE*

1186948

@@ -1248,12 +1010,12 @@ header when requesting a document from a URL:

12481010

12491011`--epub-chapter-level=`*NUMBER*

12501012

1251−: Specify the heading level at which to split the EPUB into separate

1252− "chapter" files. The default is to split into chapters at level-1

1253− headings. This option only affects the internal composition of the

1013+: Specify the header level at which to split the EPUB into separate

1014+ "chapter" files. The default is to split into chapters at level 1

1015+ headers. This option only affects the internal composition of the

12541016 EPUB, not the way chapters and sections are displayed to users. Some

12551017 readers may be slow if the chapter files are too large, so for large

1256− documents with few level-1 headings, one might want to use a chapter

1018+ documents with few level 1 headers, one might want to use a chapter

12571019 level of 2 or 3.

12581020

12591021`--epub-subdirectory=`*DIRNAME*

@@ -1262,118 +1024,69 @@ header when requesting a document from a URL:

12621024 the EPUB-specific contents. The default is `EPUB`. To put

12631025 the EPUB contents in the top level, use an empty string.

12641026

1265−`--ipynb-output=all|none|best`

1266−

1267−: Determines how ipynb output cells are treated. `all` means

1268− that all of the data formats included in the original are

1269− preserved. `none` means that the contents of data cells

1270− are omitted. `best` causes pandoc to try to pick the

1271− richest data block in each output cell that is compatible

1272− with the output format. The default is `best`.

1273−

1274−`--pdf-engine=`*PROGRAM*

1027+`--pdf-engine=pdflatex`|`lualatex`|`xelatex`|`wkhtmltopdf`|`weasyprint`|`prince`|`context`|`pdfroff`

12751028

12761029: Use the specified engine when producing PDF output.

1277− Valid values are `pdflatex`, `lualatex`, `xelatex`, `latexmk`,

1278− `tectonic`, `wkhtmltopdf`, `weasyprint`, `prince`, `context`,

1279− and `pdfroff`. If the engine is not in your PATH, the full

1280− path of the engine may be specified here. If this option

1281− is not specified, pandoc uses the following defaults

1282− depending on the output format specified using `-t/--to`:

1283−

1284− - `-t latex` or none: `pdflatex` (other options: `xelatex`, `lualatex`,

1285− `tectonic`, `latexmk`)

1286− - `-t context`: `context`

1287− - `-t html`: `wkhtmltopdf` (other options: `prince`, `weasyprint`;

1288− see [print-css.rocks](https://print-css.rocks) for a good

1289− introduction to PDF generation from HTML/CSS.)

1290− - `-t ms`: `pdfroff`

1030+ The default is `pdflatex`. If the engine is not in your PATH,

1031+ the full path of the engine may be specified here.

12911032

12921033`--pdf-engine-opt=`*STRING*

12931034

12941035: Use the given string as a command-line argument to the `pdf-engine`.

1295− For example, to use a persistent directory `foo` for `latexmk`'s

1296− auxiliary files, use `--pdf-engine-opt=-outdir=foo`.

1297− Note that no check for duplicate options is done.

1298−

1299−[Dublin Core elements]: https://www.dublincore.org/specifications/dublin-core/dces/

1300−[ISO 8601 format]: https://www.w3.org/TR/NOTE-datetime

1301−[Encoding issue with the listings package]:

1302− https://en.wikibooks.org/wiki/LaTeX/Source_Code_Listings#Encoding_issue

1303−

1304−## Citation rendering {.options}

1305−

1306−`-C`, `--citeproc`

1307−

1308−: Process the citations in the file, replacing them with

1309− rendered citations and adding a bibliography.

1310− Citation processing will not take place unless bibliographic

1311− data is supplied, either through an external file specified

1312− using the `--bibliography` option or the `bibliography`

1313− field in metadata, or via a `references` section in metadata

1314− containing a list of citations in CSL YAML format with

1315− Markdown formatting. The style is controlled by a [CSL]

1316− stylesheet specified using the `--csl` option or the `csl`

1317− field in metadata. (If no stylesheet is specified,

1318− the `chicago-author-date` style will be used by default.)

1319− The citation processing transformation may be applied before

1320− or after filters or Lua filters (see `--filter`,

1321− `--lua-filter`): these transformations are applied in the

1322− order they appear on the command line. For more

1323− information, see the section on [Citations].

1036+ If used multiple times, the arguments are provided with spaces between

1037+ them. Note that no check for duplicate options is done.

1038+

1039+[Dublin Core elements]: http://dublincore.org/documents/dces/

1040+[ISO 8601 format]: http://www.w3.org/TR/NOTE-datetime

1041+

1042+Citation rendering

1043+------------------

13241044

13251045`--bibliography=`*FILE*

13261046

13271047: Set the `bibliography` field in the document's metadata to *FILE*,

1328− overriding any value set in the metadata. If you supply

1329− this argument multiple times, each *FILE* will be added to

1330− bibliography. If *FILE* is a URL, it will be fetched

1331− via HTTP. If *FILE* is not found relative to the

1332− working directory, it will be sought in the resource path

1333− (see `--resource-path`).

1048+ overriding any value set in the metadata, and process citations

1049+ using `pandoc-citeproc`. (This is equivalent to

1050+ `--metadata bibliography=FILE --filter pandoc-citeproc`.)

1051+ If `--natbib` or `--biblatex` is also supplied, `pandoc-citeproc` is not

1052+ used, making this equivalent to `--metadata bibliography=FILE`.

1053+ If you supply this argument multiple times, each *FILE* will be added

1054+ to bibliography.

13341055

13351056`--csl=`*FILE*

13361057

13371058: Set the `csl` field in the document's metadata to *FILE*,

13381059 overriding any value set in the metadata. (This is equivalent to

1339− `--metadata csl=FILE`.) If *FILE* is a URL, it will be

1340− fetched via HTTP. If *FILE* is not found relative to the

1341− working directory, it will be sought in the resource path

1342− (see `--resource-path`) and finally in the `csl`

1343− subdirectory of the pandoc user data directory.

1060+ `--metadata csl=FILE`.)

1061+ This option is only relevant with `pandoc-citeproc`.

13441062

13451063`--citation-abbreviations=`*FILE*

13461064

13471065: Set the `citation-abbreviations` field in the document's metadata to

13481066 *FILE*, overriding any value set in the metadata. (This is equivalent to

13491067 `--metadata citation-abbreviations=FILE`.)

1350− If *FILE* is a URL, it will be fetched via HTTP. If *FILE* is not

1351− found relative to the working directory, it will be sought

1352− in the resource path (see `--resource-path`) and finally in

1353− the `csl` subdirectory of the pandoc user data directory.

1068+ This option is only relevant with `pandoc-citeproc`.

13541069

13551070`--natbib`

13561071

1357−: Use [`natbib`] for citations in LaTeX output. This option

1358− is not for use with the `--citeproc` option or with PDF

1359− output. It is intended for use in producing a LaTeX file

1360− that can be processed with [`bibtex`].

1072+: Use [`natbib`] for citations in LaTeX output. This option is not for use

1073+ with the `pandoc-citeproc` filter or with PDF output. It is intended for

1074+ use in producing a LaTeX file that can be processed with [`bibtex`].

13611075

13621076`--biblatex`

13631077

1364−: Use [`biblatex`] for citations in LaTeX output. This option

1365− is not for use with the `--citeproc` option or with PDF

1366− output. It is intended for use in producing a LaTeX file

1367− that can be processed with [`bibtex`] or [`biber`].

1078+: Use [`biblatex`] for citations in LaTeX output. This option is not for use

1079+ with the `pandoc-citeproc` filter or with PDF output. It is intended for

1080+ use in producing a LaTeX file that can be processed with [`bibtex`] or [`biber`].

13681081

1369−## Math rendering in HTML {.options}

1082+Math rendering in HTML

1083+----------------------

13701084

1371−The default is to render TeX math as far as possible using

1372−Unicode characters. Formulas are put inside a `span` with

1373−`class="math"`, so that they may be styled differently from the

1374−surrounding text if needed. However, this gives acceptable

1375−results only for basic math, usually you will want to use

1376−`--mathjax` or another of the following options.

1085+The default is to render TeX math as far as possible using Unicode characters.

1086+Formulas are put inside a `span` with `class="math"`, so that they may be styled

1087+differently from the surrounding text if needed. However, this gives acceptable

1088+results only for basic math, usually you will want to use `--mathjax` or another

1089+of the following options.

13771090

13781091`--mathjax`[`=`*URL*]

13791092

@@ -1387,11 +1100,10 @@ results only for basic math, usually you will want to use

13871100

13881101`--mathml`

13891102

1390−: Convert TeX math to [MathML] (in `epub3`, `docbook4`,

1391− `docbook5`, `jats`, `html4` and `html5`). This is the

1392− default in `odt` output. Note that currently only Firefox

1393− and Safari (and select e-book readers) natively support

1394− MathML.

1103+: Convert TeX math to [MathML] (in `epub3`, `docbook4`, `docbook5`, `jats`,

1104+ `html4` and `html5`). This is the default in `odt` output. Note that

1105+ currently only Firefox and Safari (and select e-book readers) natively

1106+ support MathML.

13951107

13961108`--webtex`[`=`*URL*]

13971109

@@ -1408,26 +1120,67 @@ results only for basic math, usually you will want to use

14081120`--katex`[`=`*URL*]

14091121

14101122: Use [KaTeX] to display embedded TeX math in HTML output.

1411− The *URL* is the base URL for the KaTeX library. That directory

1412− should contain a `katex.min.js` and a `katex.min.css` file.

1413− If a *URL* is not provided, a link to the KaTeX CDN will be inserted.

1123+ The *URL* is the base URL for the KaTeX library. If a *URL* is

1124+ not provided, a link to the KaTeX CDN will be inserted.

1125+

1126+`--katex-stylesheet=`*URL*

1127+

1128+: The *URL* should point to the `katex.css` stylesheet. If this option is

1129+ not specified, a link to the KaTeX CDN will be inserted. Note that this

1130+ option does not imply `--katex`.

1131+

1132+`-m` [*URL*], `--latexmathml`[`=`*URL*]

1133+

1134+: *Deprecated.*

1135+ Use the [LaTeXMathML] script to display embedded TeX math in HTML output.

1136+ TeX math will be displayed between `$` or `$$` characters and put in

1137+ `<span>` tags with class `LaTeX`. The LaTeXMathML JavaScript will then

1138+ change it to MathML. Note that currently only Firefox and Safari

1139+ (and select e-book readers) natively support MathML.

1140+ To insert a link the `LaTeXMathML.js` script, provide a *URL*.

1141+

1142+`--jsmath`[`=`*URL*]

1143+

1144+: *Deprecated.*

1145+ Use [jsMath] (the predecessor of MathJax) to display embedded TeX

1146+ math in HTML output. TeX math will be put inside `<span>` tags

1147+ (for inline math) or `<div>` tags (for display math) with class

1148+ `math` and rendered by the jsMath script. The *URL* should point to

1149+ the script (e.g. `jsMath/easy/load.js`); if provided, it will be linked

1150+ to in the header of standalone HTML documents. If a *URL* is not provided,

1151+ no link to the jsMath load script will be inserted; it is then

1152+ up to the author to provide such a link in the HTML template.

14141153

14151154`--gladtex`

14161155

1417−: Enclose TeX math in `<eq>` tags in HTML output. The resulting HTML

1418− can then be processed by [GladTeX] to produce SVG images of the typeset

1419− formulas and an HTML file with these images embedded.

1156+: *Deprecated.*

1157+ Enclose TeX math in `<eq>` tags in HTML output. The resulting HTML

1158+ can then be processed by [gladTeX] to produce images of the typeset

1159+ formulas and an HTML file with links to these images.

1160+ So, the procedure is:

14201161

14211162 pandoc -s --gladtex input.md -o myfile.htex

1422− gladtex -d image_dir myfile.htex

1423− # produces myfile.html and images in image_dir

1163+ gladtex -d myfile-images myfile.htex

1164+ # produces myfile.html and images in myfile-images

14241165

1425−[MathML]: https://www.w3.org/Math/

1166+`--mimetex`[`=`*URL*]

1167+

1168+: *Deprecated.*

1169+ Render TeX math using the [mimeTeX] CGI script, which generates an

1170+ image for each TeX formula. This should work in all browsers. If

1171+ *URL* is not specified, it is assumed that the script is at

1172+ `/cgi-bin/mimetex.cgi`.

1173+

1174+[MathML]: http://www.w3.org/Math/

1175+[LaTeXMathML]: http://math.etsu.edu/LaTeXMathML/

1176+[jsMath]: http://www.math.union.edu/~dpvc/jsmath/

14261177[MathJax]: https://www.mathjax.org

1178+[gladTeX]: http://ans.hsh.no/home/mgg/gladtex/

1179+[mimeTeX]: http://www.forkosh.com/mimetex.html

14271180[KaTeX]: https://github.com/Khan/KaTeX

1428−[GladTeX]: https://humenda.github.io/GladTeX/

14291181

1430−## Options for wrapper scripts {.options}

1182+Options for wrapper scripts

1183+---------------------------

14311184

14321185`--dump-args`

14331186

@@ -1451,277 +1204,8 @@ results only for basic math, usually you will want to use

14511204

14521205 pandoc -o foo.html -s

14531206

1454−# Exit codes

1455−

1456−If pandoc completes successfully, it will return exit code 0.

1457−Nonzero exit codes have the following meanings:

1458−

1459− Code Error

1460−----- ------------------------------------

1461− 3 PandocFailOnWarningError

1462− 4 PandocAppError

1463− 5 PandocTemplateError

1464− 6 PandocOptionError

1465− 21 PandocUnknownReaderError

1466− 22 PandocUnknownWriterError

1467− 23 PandocUnsupportedExtensionError

1468− 24 PandocCiteprocError

1469− 31 PandocEpubSubdirectoryError

1470− 43 PandocPDFError

1471− 44 PandocXMLError

1472− 47 PandocPDFProgramNotFoundError

1473− 61 PandocHttpError

1474− 62 PandocShouldNeverHappenError

1475− 63 PandocSomeError

1476− 64 PandocParseError

1477− 65 PandocParsecError

1478− 66 PandocMakePDFError

1479− 67 PandocSyntaxMapError

1480− 83 PandocFilterError

1481− 91 PandocMacroLoop

1482− 92 PandocUTF8DecodingError

1483− 93 PandocIpynbDecodingError

1484− 94 PandocUnsupportedCharsetError

1485− 97 PandocCouldNotFindDataFileError

1486− 99 PandocResourceNotFound

1487−----- ------------------------------------

1488−

1489−# Default files

1490−

1491−The `--defaults` option may be used to specify a package

1492−of options. Here is a sample defaults file demonstrating all of

1493−the fields that may be used:

1494−

1495−``` yaml

1496−from: markdown+emoji

1497−# reader: may be used instead of from:

1498−to: html5

1499−# writer: may be used instead of to:

1500−

1501−# leave blank for output to stdout:

1502−output-file:

1503−# leave blank for input from stdin, use [] for no input:

1504−input-files:

1505−- preface.md

1506−- content.md

1507−# or you may use input-file: with a single value

1508−

1509−# Include options from the specified defaults files.

1510−# The files will be searched for first in the working directory

1511−# and then in the defaults subdirectory of the user data directory.

1512−# The files are included in the same order in which they appear in

1513−# the list. Options specified in this defaults file always have

1514−# priority over the included ones.

1515−defaults:

1516−- defsA

1517−- defsB

1518−

1519−template: letter

1520−standalone: true

1521−self-contained: false

1522−

1523−# note that structured variables may be specified:

1524−variables:

1525− documentclass: book

1526− classoption:

1527− - twosides

1528− - draft

1529−

1530−# metadata values specified here are parsed as literal

1531−# string text, not markdown:

1532−metadata:

1533− author:

1534− - Sam Smith

1535− - Julie Liu

1536−metadata-files:

1537−- boilerplate.yaml

1538−# or you may use metadata-file: with a single value

1539−

1540−# Note that these take files, not their contents:

1541−include-before-body: []

1542−include-after-body: []

1543−include-in-header: []

1544−resource-path: ["."]

1545−

1546−# turn on built-in citation processing. Note that if you need

1547−# control over when the citeproc processing is done relative

1548−# to other filters, you should instead use `citeproc` in the

1549−# list of `filters` (see below).

1550−citeproc: true

1551−csl: ieee

1552−bibliography:

1553−- foobar.bib

1554−- barbaz.json

1555−citation-abbreviations: abbrevs.json

1556−

1557−# Filters will be assumed to be Lua filters if they have

1558−# the .lua extension, and json filters otherwise. But

1559−# the filter type can also be specified explicitly, as shown.

1560−# Filters are run in the order specified.

1561−# To include the built-in citeproc filter, use either `citeproc`

1562−# or `{type: citeproc}`.

1563−filters:

1564−- wordcount.lua

1565−- type: json

1566− path: foo.lua

1567−

1568−file-scope: false

1569−

1570−data-dir:

1571−

1572−# ERROR, WARNING, or INFO

1573−verbosity: INFO

1574−log-file: log.json

1575−

1576−# citeproc, natbib, or biblatex. This only affects LaTeX

1577−# output. If you want to use citeproc to format citations,

1578−# you should also set 'citeproc: true' (see above).

1579−cite-method: citeproc

1580−

1581−# part, chapter, section, or default:

1582−top-level-division: chapter

1583−abbreviations:

1584−

1585−pdf-engine: pdflatex

1586−pdf-engine-opts:

1587−- "-shell-escape"

1588−# you may also use pdf-engine-opt: with a single option

1589−# pdf-engine-opt: "-shell-escape"

1590−

1591−# auto, preserve, or none

1592−wrap: auto

1593−columns: 78

1594−dpi: 72

1595−

1596−extract-media: mediadir

1597−

1598−table-of-contents: true

1599−toc-depth: 2

1600−number-sections: false

1601−# a list of offsets at each heading level

1602−number-offset: [0,0,0,0,0,0]

1603−# toc: may also be used instead of table-of-contents:

1604−shift-heading-level-by: 1

1605−section-divs: true

1606−identifier-prefix: foo

1607−title-prefix: ""

1608−strip-empty-paragraphs: true

1609−# lf, crlf, or native

1610−eol: lf

1611−strip-comments: false

1612−indented-code-classes: []

1613−ascii: true

1614−default-image-extension: ".jpg"

1615−

1616−# either a style name of a style definition file:

1617−highlight-style: pygments

1618−syntax-definitions:

1619−- c.xml

1620−# or you may use syntax-definition: with a single value

1621−listings: false

1622−

1623−reference-doc: myref.docx

1624−

1625−# method is plain, webtex, gladtex, mathml, mathjax, katex

1626−# you may specify a url with webtex, mathjax, katex

1627−html-math-method:

1628− method: mathjax

1629− url: "https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"

1630−# none, references, or javascript

1631−email-obfuscation: javascript

1632−

1633−tab-stop: 8

1634−preserve-tabs: true

1635−

1636−incremental: false

1637−slide-level: 2

1638−

1639−epub-subdirectory: EPUB

1640−epub-metadata: meta.xml

1641−epub-fonts:

1642−- foobar.otf

1643−epub-chapter-level: 1

1644−epub-cover-image: cover.jpg

1645−

1646−reference-links: true

1647−# block, section, or document

1648−reference-location: block

1649−markdown-headings: setext

1650−

1651−# accept, reject, or all

1652−track-changes: accept

1653−

1654−html-q-tags: false

1655−css:

1656−- site.css

1657−

1658−# none, all, or best

1659−ipynb-output: best

1660−

1661−# A list of two-element lists

1662−request-headers:

1663−- ["User-Agent", "Mozilla/5.0"]

1664−

1665−fail-if-warnings: false

1666−dump-args: false

1667−ignore-args: false

1668−trace: false

1669−```

1670−

1671−Fields that are omitted will just have their regular

1672−default values. So a defaults file can be as simple as

1673−one line:

1674−

1675−``` yaml

1676−verbosity: INFO

1677−```

1678−

1679−In fields that expect a file path (or list of file paths), the

1680−following syntax may be used to interpolate environment variables:

1681−

1682−``` yaml

1683−csl: ${HOME}/mycsldir/special.csl

1684−```

1685−

1686−`${USERDATA}` may also be used; this will always resolve to the

1687−user data directory that is current when the defaults file is

1688−parsed, regardless of the setting of the environment

1689−variable `USERDATA`.

1690−

1691−`${.}` will resolve to the directory containing the default

1692−file itself. This allows you to refer to resources contained

1693−in that directory:

1694−

1695−``` yaml

1696−epub-cover-image: ${.}/cover.jpg

1697−epub-metadata: ${.}/meta.xml

1698−resource-path:

1699−- . # the working directory from which pandoc is run

1700−- ${.}/images # the images subdirectory of the directory

1701− # containing this defaults file

1702−```

1703−

1704−This environment variable interpolation syntax *only* works in

1705−fields that expect file paths.

1706−

1707−Default files can be placed in the `defaults` subdirectory of

1708−the user data directory and used from any directory. For

1709−example, one could create a file specifying defaults for writing

1710−letters, save it as `letter.yaml` in the `defaults` subdirectory

1711−of the user data directory, and then invoke these defaults

1712−from any directory using `pandoc --defaults letter`

1713−or `pandoc -dletter`.

1714−

1715−When multiple defaults are used, their contents will be combined.

1716−

1717−Note that, where command-line arguments may be repeated

1718−(`--metadata-file`, `--css`, `--include-in-header`,

1719−`--include-before-body`, `--include-after-body`, `--variable`,

1720−`--metadata`, `--syntax-definition`), the values specified on

1721−the command line will combine with values specified in the

1722−defaults file, rather than replacing them.

1723−

1724−# Templates

1207+Templates

1208+=========

17251209

17261210When the `-s/--standalone` option is used, pandoc uses a template to

17271211add header and footer material that is needed for a self-standing

@@ -1740,3127 +1224,2083 @@ directory (see `--data-dir`, above). *Exceptions:*

17401224- For `pdf` output, customize the `default.latex` template

17411225 (or the `default.context` template, if you use `-t context`,

17421226 or the `default.ms` template, if you use `-t ms`, or the

1743− `default.html` template, if you use `-t html`).

1744−- `docx` and `pptx` have no template (however, you can use

1227+ `default.html5` template, if you use `-t html5`).

1228+- `docx` has no template (however, you can use

17451229 `--reference-doc` to customize the output).

17461230

17471231Templates contain *variables*, which allow for the inclusion of

1748−arbitrary information at any point in the file. They may be set at the

1749−command line using the `-V/--variable` option. If a variable is not set,

1750−pandoc will look for the key in the document's metadata, which can be set

1751−using either [YAML metadata blocks][Extension: `yaml_metadata_block`]

1752−or with the `-M/--metadata` option. In addition, some variables

1753−are given default values by pandoc. See [Variables] below for

1754−a list of variables used in pandoc's default templates.

1232+arbitrary information at any point in the file. Variables may be set

1233+within the document using [YAML metadata blocks][Extension:

1234+`yaml_metadata_block`]. They may also be set at the

1235+command line using the `-V/--variable` option: variables set in this

1236+way override metadata fields with the same name.

17551237

1756−If you use custom templates, you may need to revise them as pandoc

1757−changes. We recommend tracking the changes in the default templates,

1758−and modifying your custom templates accordingly. An easy way to do this

1759−is to fork the [pandoc-templates] repository and merge in

1760−changes after each pandoc release.

1761−

1762− [pandoc-templates]: https://github.com/jgm/pandoc-templates

1238+Variables set by pandoc

1239+-----------------------

17631240

1764−## Template syntax

1241+Some variables are set automatically by pandoc. These vary somewhat

1242+depending on the output format, but include metadata fields as well

1243+as the following:

17651244

1766−### Comments

1245+`sourcefile`, `outputfile`

1246+: source and destination filenames, as given on the command line.

1247+ `sourcefile` can also be a list if input comes from multiple files, or empty

1248+ if input is from stdin. You can use the following snippet in your template

1249+ to distinguish them:

17671250

1768−Anything between the sequence `$--` and the end of the

1769−line will be treated as a comment and omitted from the output.

1251+ $if(sourcefile)$

1252+ $for(sourcefile)$

1253+ $sourcefile$

1254+ $endfor$

1255+ $else$

1256+ (stdin)

1257+ $endif$

17701258

1771−### Delimiters

1259+ Similarly, `outputfile` can be `-` if output goes to the terminal.

17721260

1773−To mark variables and control structures in the template,

1774−either `$`...`$` or `${`...`}` may be used as delimiters.

1775−The styles may also be mixed in the same template, but the

1776−opening and closing delimiter must match in each case. The

1777−opening delimiter may be followed by one or more spaces

1778−or tabs, which will be ignored. The closing delimiter may

1779−be followed by one or more spaces or tabs, which will be

1780−ignored.

1261+`title`, `author`, `date`

1262+: allow identification of basic aspects of the document. Included

1263+ in PDF metadata through LaTeX and ConTeXt. These can be set

1264+ through a [pandoc title block][Extension: `pandoc_title_block`],

1265+ which allows for multiple authors, or through a YAML metadata block:

17811266

1782−To include a literal `$` in the document, use `$$`.

1267+ ---

1268+ author:

1269+ - Aristotle

1270+ - Peter Abelard

1271+ ...

17831272

1784−### Interpolated variables

1273+`subtitle`

1274+: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and Word docx;

1275+ renders in LaTeX only when using a document class that supports

1276+ `\subtitle`, such as `beamer` or the [KOMA-Script] series (`scrartcl`,

1277+ `scrreprt`, `scrbook`).[^subtitle]

17851278

1786−A slot for an interpolated variable is a variable name surrounded

1787−by matched delimiters. Variable names must begin with a letter

1788−and can contain letters, numbers, `_`, `-`, and `.`. The

1789−keywords `it`, `if`, `else`, `endif`, `for`, `sep`, and `endfor` may

1790−not be used as variable names. Examples:

1279+`institute`

1280+: author affiliations (in LaTeX and Beamer only). Can be a

1281+ list, when there are multiple authors.

17911282

1792−```

1793−$foo$

1794−$foo.bar.baz$

1795−$foo_bar.baz-bim$

1796−$ foo $

1797−${foo}

1798−${foo.bar.baz}

1799−${foo_bar.baz-bim}

1800−${ foo }

1801−```

1283+`abstract`

1284+: document summary, included in LaTeX, ConTeXt, AsciiDoc, and Word docx

18021285

1803−Variable names with periods are used to get at structured

1804−variable values. So, for example, `employee.salary` will return the

1805−value of the `salary` field of the object that is the value of

1806−the `employee` field.

1286+`keywords`

1287+: list of keywords to be included in HTML, PDF, and AsciiDoc metadata;

1288+ may be repeated as for `author`, above

18071289

1808−- If the value of the variable is simple value, it will be

1809− rendered verbatim. (Note that no escaping is done;

1810− the assumption is that the calling program will escape

1811− the strings appropriately for the output format.)

1812−- If the value is a list, the values will be concatenated.

1813−- If the value is a map, the string `true` will be rendered.

1814−- Every other value will be rendered as the empty string.

1290+`header-includes`

1291+: contents specified by `-H/--include-in-header` (may have multiple

1292+ values)

18151293

1816−### Conditionals

1294+`toc`

1295+: non-null value if `--toc/--table-of-contents` was specified

18171296

1818−A conditional begins with `if(variable)` (enclosed in

1819−matched delimiters) and ends with `endif` (enclosed in matched

1820−delimiters). It may optionally contain an `else` (enclosed in

1821−matched delimiters). The `if` section is used if

1822−`variable` has a non-empty value, otherwise the `else`

1823−section is used (if present). Examples:

1297+`toc-title`

1298+: title of table of contents (works only with EPUB,

1299+ opendocument, odt, docx)

18241300

1825−```

1826−$if(foo)$bar$endif$

1301+`include-before`

1302+: contents specified by `-B/--include-before-body` (may have

1303+ multiple values)

18271304

1828−$if(foo)$

1829− $foo$

1830−$endif$

1305+`include-after`

1306+: contents specified by `-A/--include-after-body` (may have

1307+ multiple values)

18311308

1832−$if(foo)$

1833−part one

1834−$else$

1835−part two

1836−$endif$

1309+`body`

1310+: body of document

18371311

1838−${if(foo)}bar${endif}

1312+`meta-json`

1313+: JSON representation of all of the document's metadata. Field

1314+ values are transformed to the selected output format.

18391315

1840−${if(foo)}

1841− ${foo}

1842−${endif}

1316+[^subtitle]: To make `subtitle` work with other LaTeX

1317+ document classes, you can add the following to `header-includes`:

18431318

1844−${if(foo)}

1845−${ foo.bar }

1846−${else}

1847−no foo!

1848−${endif}

1849−```

1319+ \providecommand{\subtitle}[1]{%

1320+ \usepackage{titling}

1321+ \posttitle{%

1322+ \par\large#1\end{center}}

1323+ }

18501324

1851−The keyword `elseif` may be used to simplify complex nested

1852−conditionals:

1325+Language variables

1326+------------------

18531327

1854−```

1855−$if(foo)$

1856−XXX

1857−$elseif(bar)$

1858−YYY

1859−$else$

1860−ZZZ

1861−$endif$

1862−```

1328+`lang`

1329+: identifies the main language of the document,

1330+ using a code according to [BCP 47] (e.g. `en` or `en-GB`).

1331+ For some output formats, pandoc will convert it to an appropriate

1332+ format stored in the additional variables `babel-lang`,

1333+ `polyglossia-lang` (LaTeX) and `context-lang` (ConTeXt).

1334+

1335+ Native pandoc `span`s and `div`s with the lang attribute

1336+ (value in BCP 47) can be used to switch the language in

1337+ that range.

1338+

1339+`otherlangs`

1340+: a list of other languages used in the document

1341+ in the YAML metadata, according to [BCP 47]. For example:

1342+ `otherlangs: [en-GB, fr]`.

1343+ This is automatically generated from the `lang` attributes

1344+ in all `span`s and `div`s but can be overridden.

1345+ Currently only used by LaTeX through the generated

1346+ `babel-otherlangs` and `polyglossia-otherlangs` variables.

1347+ The LaTeX writer outputs polyglossia commands in the text but

1348+ the `babel-newcommands` variable contains mappings for them

1349+ to the corresponding babel.

18631350

1864−### For loops

1351+`dir`

1352+: the base direction of the document, either `rtl` (right-to-left)

1353+ or `ltr` (left-to-right).

18651354

1866−A for loop begins with `for(variable)` (enclosed in

1867−matched delimiters) and ends with `endfor` (enclosed in matched

1868−delimiters.

1355+ For bidirectional documents, native pandoc `span`s and `div`s

1356+ with the `dir` attribute (value `rtl` or `ltr`) can be used to

1357+ override the base direction in some output formats.

1358+ This may not always be necessary if the final renderer

1359+ (e.g. the browser, when generating HTML) supports the

1360+ [Unicode Bidirectional Algorithm].

18691361

1870−- If `variable` is an array, the material inside the loop will

1871− be evaluated repeatedly, with `variable` being set to each

1872− value of the array in turn, and concatenated.

1873−- If `variable` is a map, the material inside will be set to

1874− the map.

1875−- If the value of the associated variable is not an array or

1876− a map, a single iteration will be performed on its value.

1362+ When using LaTeX for bidirectional documents, only the `xelatex` engine

1363+ is fully supported (use `--pdf-engine=xelatex`).

18771364

1878−Examples:

1365+[BCP 47]: https://tools.ietf.org/html/bcp47

1366+[Unicode Bidirectional Algorithm]: http://www.w3.org/International/articles/inline-bidi-markup/uba-basics

18791367

1880−```

1881−$for(foo)$$foo$$sep$, $endfor$

1368+Variables for slides

1369+--------------------

18821370

1883−$for(foo)$

1884− - $foo.last$, $foo.first$

1885−$endfor$

1371+Variables are available for [producing slide shows with pandoc],

1372+including all [reveal.js configuration options].

18861373

1887−${ for(foo.bar) }

1888− - ${ foo.bar.last }, ${ foo.bar.first }

1889−${ endfor }

1374+`titlegraphic`

1375+: title graphic for Beamer documents

18901376

1891−$for(mymap)$

1892−$it.name$: $it.office$

1893−$endfor$

1894−```

1377+`logo`

1378+: logo for Beamer documents

18951379

1896−You may optionally specify a separator between consecutive

1897−values using `sep` (enclosed in matched delimiters). The

1898−material between `sep` and the `endfor` is the separator.

1380+`slidy-url`

1381+: base URL for Slidy documents (defaults to

1382+ `https://www.w3.org/Talks/Tools/Slidy2`)

18991383

1900−```

1901−${ for(foo) }${ foo }${ sep }, ${ endfor }

1902−```

1384+`slideous-url`

1385+: base URL for Slideous documents (defaults to `slideous`)

19031386

1904−Instead of using `variable` inside the loop, the special

1905−anaphoric keyword `it` may be used.

1387+`s5-url`

1388+: base URL for S5 documents (defaults to `s5/default`)

19061389

1907−```

1908−${ for(foo.bar) }

1909− - ${ it.last }, ${ it.first }

1910−${ endfor }

1911−```

1390+`revealjs-url`

1391+: base URL for reveal.js documents (defaults to `reveal.js`)

19121392

1913−### Partials

1393+`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`

1394+: themes for LaTeX [`beamer`] documents

19141395

1915−Partials (subtemplates stored in different files) may be

1916−included by using the name of the partial, followed

1917−by `()`, for example:

1396+`themeoptions`

1397+: options for LaTeX beamer themes (a list).

19181398

1919−```

1920−${ styles() }

1921−```

1399+`navigation`

1400+: controls navigation symbols in `beamer` documents

1401+ (default is `empty` for no navigation symbols; other valid values

1402+ are `frame`, `vertical`, and `horizontal`).

19221403

1923−Partials will be sought in the directory containing

1924−the main template. The file name will be assumed to

1925−have the same extension as the main template if it

1926−lacks an extension. When calling the partial, the

1927−full name including file extension can also be used:

1404+`section-titles`

1405+: enables on "title pages" for new sections in `beamer`

1406+ documents (default = true).

19281407

1929−```

1930−${ styles.html() }

1931−```

1408+`beamerarticle`

1409+: when true, the `beamerarticle` package is loaded (for

1410+ producing an article from beamer slides).

19321411

1933−(If a partial is not found in the directory of the

1934−template and the template path is given as a relative

1935−path, it will also be sought in the `templates`

1936−subdirectory of the user data directory.)

1412+`aspectratio`

1413+: aspect ratio of slides (for beamer only, `1610` for 16:10, `169` for 16:9,

1414+ `149` for 14:9, `141` for 1.41:1, `54` for 5:4, `43` for 4:3 which is the

1415+ default, and `32` for 3:2).

19371416

1938−Partials may optionally be applied to variables using

1939−a colon:

1417+[reveal.js configuration options]: https://github.com/hakimel/reveal.js#configuration

19401418

1941−```

1942−${ date:fancy() }

1419+Variables for LaTeX

1420+-------------------

19431421

1944−${ articles:bibentry() }

1945−```

1422+LaTeX variables are used when [creating a PDF].

19461423

1947−If `articles` is an array, this will iterate over its

1948−values, applying the partial `bibentry()` to each one. So the

1949−second example above is equivalent to

1424+`papersize`

1425+: paper size, e.g. `letter`, `a4`

19501426

1951−```

1952−${ for(articles) }

1953−${ it:bibentry() }

1954−${ endfor }

1955−```

1427+`fontsize`

1428+: font size for body text (e.g. `10pt`, `12pt`)

19561429

1957−Note that the anaphoric keyword `it` must be used when

1958−iterating over partials. In the above examples,

1959−the `bibentry` partial should contain `it.title`

1960−(and so on) instead of `articles.title`.

1430+`documentclass`

1431+: document class, e.g. [`article`], [`report`], [`book`], [`memoir`]

19611432

1962−Final newlines are omitted from included partials.

1433+`classoption`

1434+: option for document class, e.g. `oneside`; may be repeated

1435+ for multiple options

19631436

1964−Partials may include other partials.

1437+`geometry`

1438+: option for [`geometry`] package, e.g. `margin=1in`;

1439+ may be repeated for multiple options

19651440

1966−A separator between values of an array may be specified

1967−in square brackets, immediately after the variable name

1968−or partial:

1441+`margin-left`, `margin-right`, `margin-top`, `margin-bottom`

1442+: sets margins, if `geometry` is not used (otherwise `geometry`

1443+ overrides these)

19691444

1970−```

1971−${months[, ]}$

1445+`linestretch`

1446+: adjusts line spacing using the [`setspace`]

1447+ package, e.g. `1.25`, `1.5`

19721448

1973−${articles:bibentry()[; ]$

1974−```

1449+`fontfamily`

1450+: font package for use with `pdflatex`:

1451+ [TeX Live] includes many options, documented in the [LaTeX Font Catalogue].

1452+ The default is [Latin Modern][`lm`].

19751453

1976−The separator in this case is literal and (unlike with `sep`

1977−in an explicit `for` loop) cannot contain interpolated

1978−variables or other template directives.

1454+`fontfamilyoptions`

1455+: options for package used as `fontfamily`: e.g. `osf,sc` with

1456+ `fontfamily` set to [`mathpazo`] provides Palatino with old-style

1457+ figures and true small caps; may be repeated for multiple options

19791458

1980−### Nesting

1459+`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`

1460+: font families for use with `xelatex` or

1461+ `lualatex`: take the name of any system font, using the

1462+ [`fontspec`] package. Note that if `CJKmainfont` is used,

1463+ the [`xecjk`] package must be available.

19811464

1982−To ensure that content is "nested," that is, subsequent lines

1983−indented, use the `^` directive:

1465+`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`

1466+: options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`,

1467+ `CJKmainfont` in `xelatex` and `lualatex`. Allow for any choices

1468+ available through [`fontspec`], such as the OpenType features

1469+ `Numbers=OldStyle,Numbers=Proportional`. May be repeated for multiple options.

19841470

1985−```

1986−$item.number$ $^$$item.description$ ($item.price$)

1987−```

1471+`fontenc`

1472+: allows font encoding to be specified through `fontenc` package (with `pdflatex`);

1473+ default is `T1` (see guide to [LaTeX font encodings])

19881474

1989−In this example, if `item.description` has multiple lines,

1990−they will all be indented to line up with the first line:

1475+`microtypeoptions`

1476+: options to pass to the microtype package

19911477

1992−```

1993−00123 A fine bottle of 18-year old

1994− Oban whiskey. ($148)

1995−```

1478+`colorlinks`

1479+: add color to link text; automatically enabled if any of `linkcolor`, `citecolor`,

1480+ `urlcolor`, or `toccolor` are set

19961481

1997−To nest multiple lines to the same level, align them

1998−with the `^` directive in the template. For example:

1482+`linkcolor`, `citecolor`, `urlcolor`, `toccolor`

1483+: color for internal links, citation links, external links, and links in table of contents:

1484+ uses options allowed by [`xcolor`], including the `dvipsnames`, `svgnames`, and `x11names` lists

19991485

2000−```

2001−$item.number$ $^$$item.description$ ($item.price$)

2002− (Available til $item.sellby$.)

2003−```

1486+`links-as-notes`

1487+: causes links to be printed as footnotes

20041488

2005−will produce

1489+`indent`

1490+: uses document class settings for indentation (the default LaTeX template

1491+ otherwise removes indentation and adds space between paragraphs)

20061492

2007−```

2008−00123 A fine bottle of 18-year old

2009− Oban whiskey. ($148)

2010− (Available til March 30, 2020.)

2011−```

1493+`subparagraph`

1494+: disables default behavior of LaTeX template that redefines (sub)paragraphs

1495+ as sections, changing the appearance of nested headings in some classes

20121496

2013−If a variable occurs by itself on a line, preceded by whitespace

2014−and not followed by further text or directives on the same line,

2015−and the variable's value contains multiple lines, it will be

2016−nested automatically.

1497+`thanks`

1498+: specifies contents of acknowledgments footnote after document title.

20171499

2018−### Breakable spaces

1500+`toc`

1501+: include table of contents (can also be set using `--toc/--table-of-contents`)

20191502

2020−Normally, spaces in the template itself (as opposed to values of

2021−the interpolated variables) are not breakable, but they can be

2022−made breakable in part of the template by using the `~` keyword

2023−(ended with another `~`).

1503+`toc-depth`

1504+: level of section to include in table of contents

20241505

2025−```

2026−$~$This long line may break if the document is rendered

2027−with a short line length.$~$

2028−```

1506+`secnumdepth`

1507+: numbering depth for sections, if sections are numbered

20291508

2030−### Pipes

1509+`lof`, `lot`

1510+: include list of figures, list of tables

20311511

2032−A pipe transforms the value of a variable or partial. Pipes are

2033−specified using a slash (`/`) between the variable name (or partial)

2034−and the pipe name. Example:

1512+`bibliography`

1513+: bibliography to use for resolving references

20351514

2036−```

2037−$for(name)$

2038−$name/uppercase$

2039−$endfor$

1515+`biblio-style`

1516+: bibliography style, when used with `--natbib` and `--biblatex`.

20401517

2041−$for(metadata/pairs)$

2042−- $it.key$: $it.value$

2043−$endfor$

1518+`biblio-title`

1519+: bibliography title, when used with `--natbib` and `--biblatex`.

20441520

2045−$employee:name()/uppercase$

2046−```

1521+`biblatexoptions`

1522+: list of options for biblatex.

20471523

2048−Pipes may be chained:

1524+`natbiboptions`

1525+: list of options for natbib.

20491526

2050−```

2051−$for(employees/pairs)$

2052−$it.key/alpha/uppercase$. $it.name$

2053−$endfor$

2054−```

1527+`pagestyle`

1528+: An option for LaTeX's `\pagestyle{}`. The default article class

1529+ supports 'plain' (default), 'empty', and 'headings'; headings puts

1530+ section titles in the header.

20551531

2056−Some pipes take parameters:

1532+[`article`]: https://ctan.org/pkg/article

1533+[`report`]: https://ctan.org/pkg/report

1534+[`book`]: https://ctan.org/pkg/book

1535+[KOMA-Script]: https://ctan.org/pkg/koma-script

1536+[`memoir`]: https://ctan.org/pkg/memoir

1537+[`xcolor`]: https://ctan.org/pkg/xcolor

1538+[LaTeX Font Catalogue]: http://www.tug.dk/FontCatalogue/

1539+[`mathpazo`]: https://ctan.org/pkg/mathpazo

1540+[LaTeX font encodings]: https://ctan.org/pkg/encguide

20571541

2058−```

2059−|----------------------|------------|

2060−$for(employee)$

2061−$it.name.first/uppercase/left 20 "| "$$it.name.salary/right 10 " | " " |"$

2062−$endfor$

2063−|----------------------|------------|

2064−```

1542+Variables for ConTeXt

1543+---------------------

20651544

2066−Currently the following pipes are predefined:

1545+`papersize`

1546+: paper size, e.g. `letter`, `A4`, `landscape` (see [ConTeXt Paper Setup]);

1547+ may be repeated for multiple options

20671548

2068−- `pairs`: Converts a map or array to an array of maps,

2069− each with `key` and `value` fields. If the original

2070− value was an array, the `key` will be the array index,

2071− starting with 1.

1549+`layout`

1550+: options for page margins and text arrangement (see [ConTeXt Layout]);

1551+ may be repeated for multiple options

20721552

2073−- `uppercase`: Converts text to uppercase.

1553+`margin-left`, `margin-right`, `margin-top`, `margin-bottom`

1554+: sets margins, if `layout` is not used (otherwise `layout`

1555+ overrides these)

20741556

2075−- `lowercase`: Converts text to lowercase.

1557+`fontsize`

1558+: font size for body text (e.g. `10pt`, `12pt`)

20761559

2077−- `length`: Returns the length of the value: number

2078− of characters for a textual value, number of elements

2079− for a map or array.

1560+`mainfont`, `sansfont`, `monofont`, `mathfont`

1561+: font families: take the name of any system font (see [ConTeXt Font Switching])

20801562

2081−- `reverse`: Reverses a textual value or array,

2082− and has no effect on other values.

1563+`linkcolor`, `contrastcolor`

1564+: color for links outside and inside a page, e.g. `red`, `blue` (see [ConTeXt Color])

20831565

2084−- `first`: Returns the first value of an array, if

2085− applied to a non-empty array; otherwise returns

2086− the original value.

1566+`linkstyle`

1567+: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`, `type`, `cap`, `small`

20871568

2088−- `last`: Returns the last value of an array, if

2089− applied to a non-empty array; otherwise returns

2090− the original value.

1569+`indenting`

1570+: controls indentation of paragraphs, e.g. `yes,small,next` (see [ConTeXt Indentation]);

1571+ may be repeated for multiple options

20911572

2092−- `rest`: Returns all but the first value of an array, if

2093− applied to a non-empty array; otherwise returns

2094− the original value.

1573+`whitespace`

1574+: spacing between paragraphs, e.g. `none`, `small` (using [`setupwhitespace`])

20951575

2096−- `allbutlast`: Returns all but the last value of an array, if

2097− applied to a non-empty array; otherwise returns

2098− the original value.

1576+`interlinespace`

1577+: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);

1578+ may be repeated for multiple options

20991579

2100−- `chomp`: Removes trailing newlines (and breakable space).

1580+`headertext`, `footertext`

1581+: text to be placed in running header or footer (see [ConTeXt Headers and Footers]);

1582+ may be repeated up to four times for different placement

21011583

2102−- `nowrap`: Disables line wrapping on breakable spaces.

1584+`pagenumbering`

1585+: page number style and location (using [`setuppagenumbering`]);

1586+ may be repeated for multiple options

21031587

2104−- `alpha`: Converts textual values that can be

2105− read as an integer into lowercase alphabetic

2106− characters `a..z` (mod 26). This can be used to get lettered

2107− enumeration from array indices. To get uppercase

2108− letters, chain with `uppercase`.

1588+`toc`

1589+: include table of contents (can also be set using `--toc/--table-of-contents`)

21091590

2110−- `roman`: Converts textual values that can be

2111− read as an integer into lowercase roman numerials.

2112− This can be used to get lettered enumeration from array indices.

2113− To get uppercase roman, chain with `uppercase`.

1591+`lof`, `lot`

1592+: include list of figures, list of tables

21141593

2115−- `left n "leftborder" "rightborder"`: Renders a textual value

2116− in a block of width `n`, aligned to the left, with an optional

2117− left and right border. Has no effect on other values. This

2118− can be used to align material in tables. Widths are positive

2119− integers indicating the number of characters. Borders

2120− are strings inside double quotes; literal `"` and `\` characters

2121− must be backslash-escaped.

1594+[ConTeXt Paper Setup]: http://wiki.contextgarden.net/PaperSetup

1595+[ConTeXt Layout]: http://wiki.contextgarden.net/Layout

1596+[ConTeXt Font Switching]: http://wiki.contextgarden.net/Font_Switching

1597+[ConTeXt Color]: http://wiki.contextgarden.net/Color

1598+[ConTeXt Headers and Footers]: http://wiki.contextgarden.net/Headers_and_Footers

1599+[ConTeXt Indentation]: http://wiki.contextgarden.net/Indentation

1600+[`setupwhitespace`]: http://wiki.contextgarden.net/Command/setupwhitespace

1601+[`setupinterlinespace`]: http://wiki.contextgarden.net/Command/setupinterlinespace

1602+[`setuppagenumbering`]: http://wiki.contextgarden.net/Command/setuppagenumbering

21221603

2123−- `right n "leftborder" "rightborder"`: Renders a textual value

2124− in a block of width `n`, aligned to the right, and has no

2125− effect on other values.

1604+Variables for man pages

1605+-----------------------

21261606

2127−- `center n "leftborder" "rightborder"`: Renders a textual

2128− value in a block of width `n`, aligned to the center, and has

2129− no effect on other values.

1607+`section`

1608+: section number in man pages

21301609

1610+`header`

1611+: header in man pages

21311612

2132−## Variables

1613+`footer`

1614+: footer in man pages

21331615

2134−### Metadata variables

1616+`adjusting`

1617+: adjusts text to left (`l`), right (`r`), center (`c`),

1618+ or both (`b`) margins

21351619

2136−`title`, `author`, `date`

2137−: allow identification of basic aspects of the document. Included

2138− in PDF metadata through LaTeX and ConTeXt. These can be set

2139− through a [pandoc title block][Extension: `pandoc_title_block`],

2140− which allows for multiple authors, or through a

2141− [YAML metadata block][Extension: `yaml_metadata_block`]:

1620+`hyphenate`

1621+: if `true` (the default), hyphenation will be used

21421622

2143− ---

2144− author:

2145− - Aristotle

2146− - Peter Abelard

2147− ...

1623+Variables for ms

1624+----------------

21481625

2149− Note that if you just want to set PDF or HTML metadata, without

2150− including a title block in the document itself, you can

2151− set the `title-meta`, `author-meta`, and `date-meta`

2152− variables. (By default these are set automatically, based

2153− on `title`, `author`, and `date`.) The page title in HTML

2154− is set by `pagetitle`, which is equal to `title` by default.

1626+`pointsize`

1627+: point size (e.g. `10p`)

21551628

2156−`subtitle`

2157−: document subtitle, included in HTML, EPUB, LaTeX, ConTeXt, and docx

2158− documents

1629+`lineheight`

1630+: line height (e.g. `12p`)

21591631

2160−`abstract`

2161−: document summary, included in LaTeX, ConTeXt, AsciiDoc, and docx

2162− documents

1632+`fontfamily`

1633+: font family (e.g. `T` or `P`)

21631634

2164−`keywords`

2165−: list of keywords to be included in HTML, PDF, ODT, pptx, docx

2166− and AsciiDoc metadata; repeat as for `author`, above

1635+`indent`

1636+: paragraph indent (e.g. `2m`)

21671637

2168−`subject`

2169−: document subject, included in ODT, PDF, docx and pptx metadata

1638+Using variables in templates

1639+----------------------------

21701640

2171−`description`

2172−: document description, included in ODT, docx and pptx metadata. Some

2173− applications show this as `Comments` metadata.

1641+Variable names are sequences of alphanumerics, `-`, and `_`,

1642+starting with a letter. A variable name surrounded by `$` signs

1643+will be replaced by its value. For example, the string `$title$` in

21741644

2175−`category`

2176−: document category, included in docx and pptx metadata

1645+ <title>$title$</title>

21771646

2178−Additionally,

2179−any root-level string metadata, not included in ODT, docx

2180−or pptx metadata is added as a *custom property*.

2181−The following [YAML] metadata block for instance:

1647+will be replaced by the document title.

21821648

2183− ---

2184− title: 'This is the title'

2185− subtitle: "This is the subtitle"

2186− author:

2187− - Author One

2188− - Author Two

2189− description: |

2190− This is a long

2191− description.

1649+To write a literal `$` in a template, use `$$`.

21921650

2193− It consists of two paragraphs

2194− ...

1651+Templates may contain conditionals. The syntax is as follows:

21951652

2196−will include `title`, `author` and `description` as standard document

2197−properties and `subtitle` as a custom property when converting to docx,

2198−ODT or pptx.

1653+ $if(variable)$

1654+ X

1655+ $else$

1656+ Y

1657+ $endif$

21991658

2200−### Language variables

1659+This will include `X` in the template if `variable` has a non-null

1660+value; otherwise it will include `Y`. `X` and `Y` are placeholders for

1661+any valid template text, and may include interpolated variables or other

1662+conditionals. The `$else$` section may be omitted.

22011663

2202−`lang`

2203−: identifies the main language of the document using IETF language

2204− tags (following the [BCP 47] standard), such as `en` or `en-GB`.

2205− The [Language subtag lookup] tool can look up or verify these tags.

2206− This affects most formats, and controls hyphenation in PDF output

2207− when using LaTeX (through [`babel`] and [`polyglossia`]) or ConTeXt.

1664+When variables can have multiple values (for example, `author` in

1665+a multi-author document), you can use the `$for$` keyword:

22081666

2209− Use native pandoc [Divs and Spans] with the `lang` attribute to

2210− switch the language:

1667+ $for(author)$

1668+ <meta name="author" content="$author$" />

1669+ $endfor$

22111670

2212− ---

2213− lang: en-GB

2214− ...

1671+You can optionally specify a separator to be used between

1672+consecutive items:

22151673

2216− Text in the main document language (British English).

1674+ $for(author)$$author$$sep$, $endfor$

22171675

2218− ::: {lang=fr-CA}

2219− > Cette citation est écrite en français canadien.

2220− :::

1676+A dot can be used to select a field of a variable that takes

1677+an object as its value. So, for example:

22211678

2222− More text in English. ['Zitat auf Deutsch.']{lang=de}

1679+ $author.name$ ($author.affiliation$)

22231680

2224−`dir`

2225−: the base script direction, either `rtl` (right-to-left)

2226− or `ltr` (left-to-right).

1681+If you use custom templates, you may need to revise them as pandoc

1682+changes. We recommend tracking the changes in the default templates,

1683+and modifying your custom templates accordingly. An easy way to do this

1684+is to fork the [pandoc-templates] repository and merge in changes after each

1685+pandoc release.

22271686

2228− For bidirectional documents, native pandoc `span`s and

2229− `div`s with the `dir` attribute (value `rtl` or `ltr`) can

2230− be used to override the base direction in some output

2231− formats. This may not always be necessary if the final

2232− renderer (e.g. the browser, when generating HTML) supports

2233− the [Unicode Bidirectional Algorithm].

1687+Templates may contain comments: anything on a line after `$--`

1688+will be treated as a comment and ignored.

22341689

2235− When using LaTeX for bidirectional documents, only the

2236− `xelatex` engine is fully supported (use

2237− `--pdf-engine=xelatex`).

1690+[pandoc-templates]: https://github.com/jgm/pandoc-templates

22381691

2239−[BCP 47]: https://tools.ietf.org/html/bcp47

2240−[Unicode Bidirectional Algorithm]: https://www.w3.org/International/articles/inline-bidi-markup/uba-basics

2241−[Language subtag lookup]: https://r12a.github.io/app-subtags/

1692+Extensions

1693+==========

22421694

2243−### Variables for HTML

1695+The behavior of some of the readers and writers can be adjusted by

1696+enabling or disabling various extensions.

22441697

2245−`document-css`

2246−: Enables inclusion of most of the [CSS] in the `styles.html`

2247− [partial](#partials) (have a look with

2248− `pandoc --print-default-data-file=templates/styles.html`).

2249− Unless you use [`--css`](#option--css), this variable

2250− is set to `true` by default. You can disable it with

2251− e.g. `pandoc -M document-css=false`.

1698+An extension can be enabled by adding `+EXTENSION`

1699+to the format name and disabled by adding `-EXTENSION`. For example,

1700+`--from markdown_strict+footnotes` is strict Markdown with footnotes

1701+enabled, while `--from markdown-footnotes-pipe_tables` is pandoc's

1702+Markdown without footnotes or pipe tables.

22521703

2253−`mainfont`

2254−: sets the CSS `font-family` property on the `html` element.

1704+The markdown reader and writer make by far the most use of extensions.

1705+Extensions only used by them are therefore covered in the

1706+section [Pandoc's Markdown] below (See [Markdown variants] for

1707+`commonmark` and `gfm`.) In the following, extensions that also work

1708+for other formats are covered.

22551709

2256−`fontsize`

2257−: sets the base CSS `font-size`, which you'd usually set

2258− to e.g. `20px`, but it also accepts `pt`

2259− (12pt = 16px in most browsers).

1710+Typography

1711+----------

22601712

2261−`fontcolor`

2262−: sets the CSS `color` property on the `html` element.

1713+#### Extension: `smart` ####

22631714

2264−`linkcolor`

2265−: sets the CSS `color` property on all links.

1715+Interpret straight quotes as curly quotes, `---` as em-dashes,

1716+`--` as en-dashes, and `...` as ellipses. Nonbreaking spaces are

1717+inserted after certain abbreviations, such as "Mr."

22661718

2267−`monofont`

2268−: sets the CSS `font-family` property on `code` elements.

1719+This extension can be enabled/disabled for the following formats:

22691720

2270−`monobackgroundcolor`

2271−: sets the CSS `background-color` property on `code` elements

2272− and adds extra padding.

1721+input formats

1722+: `markdown`, `commonmark`, `latex`, `mediawiki`, `org`, `rst`, `twiki`

22731723

2274−`linestretch`

2275−: sets the CSS `line-height` property on the `html` element,

2276− which is preferred to be unitless.

1724+output formats

1725+: `markdown`, `latex`, `context`, `rst`

22771726

2278−`backgroundcolor`

2279−: sets the CSS `background-color` property on the `html` element.

1727+enabled by default in

1728+: `markdown`, `latex`, `context` (both input and output)

22801729

2281−`margin-left`, `margin-right`, `margin-top`, `margin-bottom`

2282−: sets the corresponding CSS `padding` properties on the `body` element.

1730+Note: If you are *writing* Markdown, then the `smart` extension

1731+has the reverse effect: what would have been curly quotes comes

1732+out straight.

22831733

2284−To override or extend some [CSS] for just one document, include for example:

1734+In LaTeX, `smart` means to use the standard TeX ligatures

1735+for quotation marks (` `` ` and ` '' ` for double quotes,

1736+`` ` `` and `` ' `` for single quotes) and dashes (`--` for

1737+en-dash and `---` for em-dash). If `smart` is disabled,

1738+then in reading LaTeX pandoc will parse these characters

1739+literally. In writing LaTeX, enabling `smart` tells pandoc

1740+to use the ligatures when possible; if `smart` is disabled

1741+pandoc will use unicode quotation mark and dash characters.

22851742

2286− ---

2287− header-includes: |

2288− <style>

2289− blockquote {

2290− font-style: italic;

2291− }

2292− tr.even {

2293− background-color: #f0f0f0;

2294− }

2295− td, th {

2296− padding: 0.5em 2em 0.5em 0.5em;

2297− }

2298− tbody {

2299− border-bottom: none;

2300− }

2301− </style>

2302− ---

1743+Headers and sections

1744+--------------------

23031745

2304−[CSS]: https://developer.mozilla.org/en-US/docs/Learn/CSS

1746+#### Extension: `auto_identifiers` ####

23051747

2306−### Variables for HTML math

1748+A header without an explicitly specified identifier will be

1749+automatically assigned a unique identifier based on the header text.

23071750

2308−`classoption`

2309−: when using [KaTeX](#option--katex), you can render display

2310−math equations flush left using [YAML metadata](#layout) or with

2311−`-M classoption=fleqn`.

1751+This extension can be enabled/disabled for the following formats:

23121752

2313−### Variables for HTML slides

1753+input formats

1754+: `markdown`, `latex`, `rst`, `mediawiki`, `textile`

23141755

2315−These affect HTML output when [producing slide shows with pandoc].

1756+output formats

1757+: `markdown`, `muse`

23161758

2317−`institute`

2318−: author affiliations: can be a list when there are multiple authors

1759+enabled by default in

1760+: `markdown`, `muse`

23191761

2320−`revealjs-url`

2321−: base URL for reveal.js documents (defaults to

2322− `https://unpkg.com/reveal.js@^4/`)

1762+The algorithm used to derive the identifier from the header text is:

23231763

2324−`s5-url`

2325−: base URL for S5 documents (defaults to `s5/default`)

1764+ - Remove all formatting, links, etc.

1765+ - Remove all footnotes.

1766+ - Remove all punctuation, except underscores, hyphens, and periods.

1767+ - Replace all spaces and newlines with hyphens.

1768+ - Convert all alphabetic characters to lowercase.

1769+ - Remove everything up to the first letter (identifiers may

1770+ not begin with a number or punctuation mark).

1771+ - If nothing is left after this, use the identifier `section`.

23261772

2327−`slidy-url`

2328−: base URL for Slidy documents (defaults to

2329− `https://www.w3.org/Talks/Tools/Slidy2`)

1773+Thus, for example,

23301774

2331−`slideous-url`

2332−: base URL for Slideous documents (defaults to `slideous`)

1775+ Header Identifier

1776+ ------------------------------- ----------------------------

1777+ `Header identifiers in HTML` `header-identifiers-in-html`

1778+ `*Dogs*?--in *my* house?` `dogs--in-my-house`

1779+ `[HTML], [S5], or [RTF]?` `html-s5-or-rtf`

1780+ `3. Applications` `applications`

1781+ `33` `section`

23331782

2334−`title-slide-attributes`

2335−: additional attributes for the title slide of reveal.js slide shows.

2336− See [background in reveal.js and beamer] for an example.

1783+These rules should, in most cases, allow one to determine the identifier

1784+from the header text. The exception is when several headers have the

1785+same text; in this case, the first will get an identifier as described

1786+above; the second will get the same identifier with `-1` appended; the

1787+third with `-2`; and so on.

23371788

2338−All [reveal.js configuration options] are available as variables.

2339−To turn off boolean flags that default to true in reveal.js, use `0`.

1789+These identifiers are used to provide link targets in the table of

1790+contents generated by the `--toc|--table-of-contents` option. They

1791+also make it easy to provide links from one section of a document to

1792+another. A link to this section, for example, might look like this:

23401793

2341−[reveal.js configuration options]: https://revealjs.com/config/

1794+ See the section on

1795+ [header identifiers](#header-identifiers-in-html-latex-and-context).

23421796

2343−### Variables for Beamer slides

1797+Note, however, that this method of providing links to sections works

1798+only in HTML, LaTeX, and ConTeXt formats.

23441799

2345−These variables change the appearance of PDF slides using [`beamer`].

1800+If the `--section-divs` option is specified, then each section will

1801+be wrapped in a `section` (or a `div`, if `html4` was specified),

1802+and the identifier will be attached to the enclosing `<section>`

1803+(or `<div>`) tag rather than the header itself. This allows entire

1804+sections to be manipulated using JavaScript or treated differently in

1805+CSS.

23461806

2347−`aspectratio`

2348−: slide aspect ratio (`43` for 4:3 [default], `169` for 16:9,

2349− `1610` for 16:10, `149` for 14:9, `141` for 1.41:1, `54` for 5:4,

2350− `32` for 3:2)

1807+#### Extension: `ascii_identifiers` ####

23511808

2352−`beamerarticle`

2353−: produce an article from Beamer slides

1809+Causes the identifiers produced by `auto_identifiers` to be pure ASCII.

1810+Accents are stripped off of accented Latin letters, and non-Latin

1811+letters are omitted.

23541812

2355−`beameroption`

2356−: add extra beamer option with `\setbeameroption{}`

1813+Math Input

1814+----------

23571815

2358−`institute`

2359−: author affiliations: can be a list when there are multiple authors

1816+The extensions [`tex_math_dollars`](#extension-tex_math_dollars),

1817+[`tex_math_single_backslash`](#extension-tex_math_single_backslash), and

1818+[`tex_math_double_backslash`](#extension-tex_math_double_backslash)

1819+are described in the section about Pandoc's Markdown.

23601820

2361−`logo`

2362−: logo image for slides

1821+However, they can also be used with HTML input. This is handy for

1822+reading web pages formatted using MathJax, for example.

23631823

2364−`navigation`

2365−: controls navigation symbols (default is `empty` for no navigation

2366− symbols; other valid values are `frame`, `vertical`, and `horizontal`)

1824+Raw HTML/TeX

1825+------------

23671826

2368−`section-titles`

2369−: enables "title pages" for new sections (default is true)

1827+The following extensions (especially how they affect Markdown

1828+input/output) are also described in more detail in their respective

1829+sections of [Pandoc's Markdown].

23701830

2371−`theme`, `colortheme`, `fonttheme`, `innertheme`, `outertheme`

2372−: beamer themes

1831+#### [Extension: `raw_html`] {#raw_html}

23731832

2374−`themeoptions`

2375−: options for LaTeX beamer themes (a list).

1833+When converting from HTML, parse elements to raw HTML which are not

1834+representable in pandoc's AST.

1835+By default, this is disabled for HTML input.

23761836

2377−`titlegraphic`

2378−: image for title slide

1837+#### [Extension: `raw_tex`] {#raw_tex}

23791838

2380−### Variables for PowerPoint

1839+Allows raw LaTeX, TeX, and ConTeXt to be included in a document.

23811840

2382−These variables control the visual aspects of a slide show that

2383−are not easily controlled via templates.

1841+This extension can be enabled/disabled for the following formats

1842+(in addition to `markdown`):

23841843

2385−`monofont`

2386−: font to use for code.

1844+input formats

1845+: `latex`, `org`, `textile`

23871846

2388−### Variables for LaTeX

1847+output formats

1848+: `textile`

23891849

2390−Pandoc uses these variables when [creating a PDF] with a LaTeX engine.

1850+#### [Extension: `native_divs`] {#native_divs}

23911851

2392−#### Layout

1852+This extension is enabled by default for HTML input. This means that

1853+`div`s are parsed to pandoc native elements. (Alternatively, you

1854+can parse them to raw HTML using `-f html-native_divs+raw_html`.)

23931855

2394−`block-headings`

2395−: make `\paragraph` and `\subparagraph` (fourth- and

2396− fifth-level headings, or fifth- and sixth-level with book

2397− classes) free-standing rather than run-in; requires further

2398− formatting to distinguish from `\subsubsection` (third- or

2399− fourth-level headings). Instead of using this option,

2400− [KOMA-Script] can adjust headings more extensively:

1856+When converting HTML to Markdown, for example, you may want to drop all

1857+`div`s and `span`s:

24011858

2402− ---

2403− documentclass: scrartcl

2404− header-includes: |

2405− \RedeclareSectionCommand[

2406− beforeskip=-10pt plus -2pt minus -1pt,

2407− afterskip=1sp plus -1sp minus 1sp,

2408− font=\normalfont\itshape]{paragraph}

2409− \RedeclareSectionCommand[

2410− beforeskip=-10pt plus -2pt minus -1pt,

2411− afterskip=1sp plus -1sp minus 1sp,

2412− font=\normalfont\scshape,

2413− indent=0pt]{subparagraph}

2414− ...

1859+ pandoc -f html-native_divs-native_spans -t markdown

24151860

2416−`classoption`

2417−: option for document class, e.g. `oneside`; repeat for multiple options:

1861+#### [Extension: `native_spans`] {#native_spans}

24181862

2419− ---

2420− classoption:

2421− - twocolumn

2422− - landscape

2423− ...

1863+Analogous to `native_divs` above.

24241864

2425−`documentclass`

2426−: document class: usually one of the standard classes,

2427− [`article`], [`book`], and [`report`]; the [KOMA-Script]

2428− equivalents, `scrartcl`, `scrbook`, and `scrreprt`, which

2429− default to smaller margins; or [`memoir`]

24301865

2431−`geometry`

2432−: option for [`geometry`] package, e.g. `margin=1in`;

2433− repeat for multiple options:

1866+Literate Haskell support

1867+------------------------

24341868

2435− ---

2436− geometry:

2437− - top=30mm

2438− - left=20mm

2439− - heightrounded

2440− ...

1869+#### Extension: `literate_haskell` ####

24411870

2442−`hyperrefoptions`

2443−: option for [`hyperref`] package, e.g. `linktoc=all`;

2444− repeat for multiple options:

1871+Treat the document as literate Haskell source.

24451872

2446− ---

2447− hyperrefoptions:

2448− - linktoc=all

2449− - pdfwindowui

2450− - pdfpagemode=FullScreen

2451− ...

1873+This extension can be enabled/disabled for the following formats:

24521874

2453−`indent`

2454−: if true, pandoc will use document class settings for

2455− indentation (the default LaTeX template otherwise removes

2456− indentation and adds space between paragraphs)

1875+input formats

1876+: `markdown`, `rst`, `latex`

24571877

2458−`linestretch`

2459−: adjusts line spacing using the [`setspace`]

2460− package, e.g. `1.25`, `1.5`

1878+output formats

1879+: `markdown`, `rst`, `latex`, `html`

24611880

2462−`margin-left`, `margin-right`, `margin-top`, `margin-bottom`

2463−: sets margins if `geometry` is not used (otherwise `geometry`

2464− overrides these)

1881+If you append `+lhs` (or `+literate_haskell`) to one of the formats

1882+above, pandoc will treat the document as literate Haskell source.

1883+This means that

24651884

2466−`pagestyle`

2467−: control `\pagestyle{}`: the default article class

2468− supports `plain` (default), `empty` (no running heads or page numbers),

2469− and `headings` (section titles in running heads)

1885+ - In Markdown input, "bird track" sections will be parsed as Haskell

1886+ code rather than block quotations. Text between `\begin{code}`

1887+ and `\end{code}` will also be treated as Haskell code. For

1888+ ATX-style headers the character '=' will be used instead of '#'.

24701889

2471−`papersize`

2472−: paper size, e.g. `letter`, `a4`

1890+ - In Markdown output, code blocks with classes `haskell` and `literate`

1891+ will be rendered using bird tracks, and block quotations will be

1892+ indented one space, so they will not be treated as Haskell code.

1893+ In addition, headers will be rendered setext-style (with underlines)

1894+ rather than ATX-style (with '#' characters). (This is because ghc

1895+ treats '#' characters in column 1 as introducing line numbers.)

24731896

2474−`secnumdepth`

2475−: numbering depth for sections (with `--number-sections` option

2476− or `numbersections` variable)

1897+ - In restructured text input, "bird track" sections will be parsed

1898+ as Haskell code.

24771899

2478−#### Fonts

1900+ - In restructured text output, code blocks with class `haskell` will

1901+ be rendered using bird tracks.

24791902

2480−`fontenc`

2481−: allows font encoding to be specified through `fontenc` package (with

2482− `pdflatex`); default is `T1` (see [LaTeX font encodings guide])

1903+ - In LaTeX input, text in `code` environments will be parsed as

1904+ Haskell code.

24831905

2484−`fontfamily`

2485−: font package for use with `pdflatex`:

2486− [TeX Live] includes many options, documented in the [LaTeX Font Catalogue].

2487− The default is [Latin Modern][`lm`].

1906+ - In LaTeX output, code blocks with class `haskell` will be rendered

1907+ inside `code` environments.

24881908

2489−`fontfamilyoptions`

2490−: options for package used as `fontfamily`; repeat for multiple options.

2491− For example, to use the Libertine font with proportional lowercase

2492− (old-style) figures through the [`libertinus`] package:

1909+ - In HTML output, code blocks with class `haskell` will be rendered

1910+ with class `literatehaskell` and bird tracks.

24931911

2494− ---

2495− fontfamily: libertinus

2496− fontfamilyoptions:

2497− - osf

2498− - p

2499− ...

1912+Examples:

25001913

2501−`fontsize`

2502−: font size for body text. The standard classes allow 10pt, 11pt, and

2503− 12pt. To use another size, set `documentclass` to one of

2504− the [KOMA-Script] classes, such as `scrartcl` or `scrbook`.

1914+ pandoc -f markdown+lhs -t html

25051915

2506−`mainfont`, `sansfont`, `monofont`, `mathfont`, `CJKmainfont`

2507−: font families for use with `xelatex` or

2508− `lualatex`: take the name of any system font, using the

2509− [`fontspec`] package. `CJKmainfont` uses the [`xecjk`] package.

1916+reads literate Haskell source formatted with Markdown conventions and writes

1917+ordinary HTML (without bird tracks).

25101918

2511−`mainfontoptions`, `sansfontoptions`, `monofontoptions`, `mathfontoptions`, `CJKoptions`

2512−: options to use with `mainfont`, `sansfont`, `monofont`, `mathfont`,

2513− `CJKmainfont` in `xelatex` and `lualatex`. Allow for any

2514− choices available through [`fontspec`]; repeat for multiple

2515− options. For example, to use the [TeX Gyre] version of

2516− Palatino with lowercase figures:

1919+ pandoc -f markdown+lhs -t html+lhs

25171920

2518− ---

2519− mainfont: TeX Gyre Pagella

2520− mainfontoptions:

2521− - Numbers=Lowercase

2522− - Numbers=Proportional

2523− ...

1921+writes HTML with the Haskell code in bird tracks, so it can be copied

1922+and pasted as literate Haskell source.

25241923

2525−`microtypeoptions`

2526−: options to pass to the microtype package

1924+Note that GHC expects the bird tracks in the first column, so indentend literate

1925+code blocks (e.g. inside an itemized environment) will not be picked up by the

1926+Haskell compiler.

25271927

2528−#### Links

1928+Other extensions

1929+----------------

25291930

2530−`colorlinks`

2531−: add color to link text; automatically enabled if any of

2532− `linkcolor`, `filecolor`, `citecolor`, `urlcolor`, or `toccolor` are set

1931+#### Extension: `empty_paragraphs` ####

25331932

2534−`linkcolor`, `filecolor`, `citecolor`, `urlcolor`, `toccolor`

2535−: color for internal links, external links, citation links, linked

2536− URLs, and links in table of contents, respectively: uses options

2537− allowed by [`xcolor`], including the `dvipsnames`, `svgnames`, and

2538− `x11names` lists

1933+Allows empty paragraphs. By default empty paragraphs are

1934+omitted.

25391935

2540−`links-as-notes`

2541−: causes links to be printed as footnotes

1936+This extension can be enabled/disabled for the following formats:

25421937

2543−#### Front matter

1938+input formats

1939+: `docx`, `html`

25441940

2545−`lof`, `lot`

2546−: include list of figures, list of tables

1941+output formats

1942+: `markdown`, `docx`, `odt`, `opendocument`, `html`

25471943

2548−`thanks`

2549−: contents of acknowledgments footnote after document title

1944+#### Extension: `amuse` ####

25501945

2551−`toc`

2552−: include table of contents (can also be set using

2553− `--toc/--table-of-contents`)

1946+In the `muse` input format, this enables Text::Amuse

1947+extensions to Emacs Muse markup.

25541948

2555−`toc-depth`

2556−: level of section to include in table of contents

1949+#### Extension: `citations` {#org-citations}

25571950

2558−#### BibLaTeX Bibliographies

1951+Some aspects of [Pandoc's Markdown citation syntax](#citations) are also accepted

1952+in `org` input.

25591953

2560−These variables function when using BibLaTeX for [citation rendering].

25611954

2562−`biblatexoptions`

2563−: list of options for biblatex

1955+Pandoc's Markdown

1956+=================

25641957

2565−`biblio-style`

2566−: bibliography style, when used with `--natbib` and `--biblatex`.

1958+Pandoc understands an extended and slightly revised version of

1959+John Gruber's [Markdown] syntax. This document explains the syntax,

1960+noting differences from standard Markdown. Except where noted, these

1961+differences can be suppressed by using the `markdown_strict` format instead

1962+of `markdown`. Extensions can be enabled or disabled to specify the

1963+behavior more granularly. They are described in the following. See also

1964+[Extensions] above, for extensions that work also on other formats.

25671965

2568−`biblio-title`

2569−: bibliography title, when used with `--natbib` and `--biblatex`.

1966+Philosophy

1967+----------

25701968

2571−`bibliography`

2572−: bibliography to use for resolving references

1969+Markdown is designed to be easy to write, and, even more importantly,

1970+easy to read:

25731971

2574−`natbiboptions`

2575−: list of options for natbib

1972+> A Markdown-formatted document should be publishable as-is, as plain

1973+> text, without looking like it's been marked up with tags or formatting

1974+> instructions.

1975+> -- [John Gruber](http://daringfireball.net/projects/markdown/syntax#philosophy)

25761976

2577−[KOMA-Script]: https://ctan.org/pkg/koma-script

2578−[LaTeX Font Catalogue]: https://tug.org/FontCatalogue/

2579−[LaTeX font encodings guide]: https://ctan.org/pkg/encguide

2580−[TeX Gyre]: http://www.gust.org.pl/projects/e-foundry/tex-gyre

2581−[`article`]: https://ctan.org/pkg/article

2582−[`book`]: https://ctan.org/pkg/book

2583−[`libertinus`]: https://ctan.org/pkg/libertinus

2584−[`memoir`]: https://ctan.org/pkg/memoir

2585−[`report`]: https://ctan.org/pkg/report

1977+This principle has guided pandoc's decisions in finding syntax for

1978+tables, footnotes, and other extensions.

25861979

2587−### Variables for ConTeXt

1980+There is, however, one respect in which pandoc's aims are different

1981+from the original aims of Markdown. Whereas Markdown was originally

1982+designed with HTML generation in mind, pandoc is designed for multiple

1983+output formats. Thus, while pandoc allows the embedding of raw HTML,

1984+it discourages it, and provides other, non-HTMLish ways of representing

1985+important document elements like definition lists, tables, mathematics, and

1986+footnotes.

25881987

2589−Pandoc uses these variables when [creating a PDF] with ConTeXt.

1988+Paragraphs

1989+----------

25901990

2591−`fontsize`

2592−: font size for body text (e.g. `10pt`, `12pt`)

1991+A paragraph is one or more lines of text followed by one or more blank lines.

1992+Newlines are treated as spaces, so you can reflow your paragraphs as you like.

1993+If you need a hard line break, put two or more spaces at the end of a line.

25931994

2594−`headertext`, `footertext`

2595−: text to be placed in running header or footer (see [ConTeXt Headers and

2596− Footers]); repeat up to four times for different placement

1995+#### Extension: `escaped_line_breaks` ####

25971996

2598−`indenting`

2599−: controls indentation of paragraphs, e.g. `yes,small,next` (see

2600− [ConTeXt Indentation]); repeat for multiple options

1997+A backslash followed by a newline is also a hard line break.

1998+Note: in multiline and grid table cells, this is the only way

1999+to create a hard line break, since trailing spaces in the cells

2000+are ignored.

26012001

2602−`interlinespace`

2603−: adjusts line spacing, e.g. `4ex` (using [`setupinterlinespace`]);

2604− repeat for multiple options

2002+Headers

2003+-------

26052004

2606−`layout`

2607−: options for page margins and text arrangement (see [ConTeXt Layout]);

2608− repeat for multiple options

2005+There are two kinds of headers: Setext and ATX.

26092006

2610−`linkcolor`, `contrastcolor`

2611−: color for links outside and inside a page, e.g. `red`, `blue` (see

2612− [ConTeXt Color])

2007+### Setext-style headers ###

26132008

2614−`linkstyle`

2615−: typeface style for links, e.g. `normal`, `bold`, `slanted`, `boldslanted`,

2616− `type`, `cap`, `small`

2009+A setext-style header is a line of text "underlined" with a row of `=` signs

2010+(for a level one header) or `-` signs (for a level two header):

26172011

2618−`lof`, `lot`

2619−: include list of figures, list of tables

2012+ A level-one header

2013+ ==================

26202014

2621−`mainfont`, `sansfont`, `monofont`, `mathfont`

2622−: font families: take the name of any system font (see

2623− [ConTeXt Font Switching])

2015+ A level-two header

2016+ ------------------

26242017

2625−`margin-left`, `margin-right`, `margin-top`, `margin-bottom`

2626−: sets margins, if `layout` is not used (otherwise `layout`

2627− overrides these)

2018+The header text can contain inline formatting, such as emphasis (see

2019+[Inline formatting], below).

26282020

2629−`pagenumbering`

2630−: page number style and location (using [`setuppagenumbering`]);

2631− repeat for multiple options

26322021

2633−`papersize`

2634−: paper size, e.g. `letter`, `A4`, `landscape` (see [ConTeXt Paper Setup]);

2635− repeat for multiple options

2636−

2637−`pdfa`

2638−: adds to the preamble the setup necessary to generate PDF/A

2639− of the type specified, e.g. `1a:2005`, `2a`. If no type is

2640− specified (i.e. the value is set to True, by e.g.

2641− `--metadata=pdfa` or `pdfa: true` in a YAML metadata block),

2642− `1b:2005` will be used as default, for reasons of backwards

2643− compatibility. Using `--variable=pdfa` without specified value

2644− is not supported. To successfully generate PDF/A the required

2645− ICC color profiles have to be available and the content and all

2646− included files (such as images) have to be standard conforming.

2647− The ICC profiles and output intent may be specified using the

2648− variables `pdfaiccprofile` and `pdfaintent`. See also [ConTeXt

2649− PDFA] for more details.

2650−

2651−`pdfaiccprofile`

2652−: when used in conjunction with `pdfa`, specifies the ICC profile to use

2653− in the PDF, e.g. `default.cmyk`. If left unspecified, `sRGB.icc` is

2654− used as default. May be repeated to include multiple profiles. Note that

2655− the profiles have to be available on the system. They can be obtained

2656− from [ConTeXt ICC Profiles].

2657−

2658−`pdfaintent`

2659−: when used in conjunction with `pdfa`, specifies the output intent for

2660− the colors, e.g. `ISO coated v2 300\letterpercent\space (ECI)`

2661− If left unspecified, `sRGB IEC61966-2.1` is used as default.

2022+### ATX-style headers ###

26622023

2663−`toc`

2664−: include table of contents (can also be set using

2665− `--toc/--table-of-contents`)

2024+An ATX-style header consists of one to six `#` signs and a line of

2025+text, optionally followed by any number of `#` signs. The number of

2026+`#` signs at the beginning of the line is the header level:

26662027

2667−`whitespace`

2668−: spacing between paragraphs, e.g. `none`, `small` (using

2669− [`setupwhitespace`])

2028+ ## A level-two header

26702029

2671−`includesource`

2672−: include all source documents as file attachments in the PDF file

2030+ ### A level-three header ###

26732031

2674−[ConTeXt Paper Setup]: https://wiki.contextgarden.net/PaperSetup

2675−[ConTeXt Layout]: https://wiki.contextgarden.net/Layout

2676−[ConTeXt Font Switching]: https://wiki.contextgarden.net/Font_Switching

2677−[ConTeXt Color]: https://wiki.contextgarden.net/Color

2678−[ConTeXt Headers and Footers]: https://wiki.contextgarden.net/Headers_and_Footers

2679−[ConTeXt Indentation]: https://wiki.contextgarden.net/Indentation

2680−[ConTeXt ICC Profiles]: https://wiki.contextgarden.net/PDFX#ICC_profiles

2681−[ConTeXt PDFA]: https://wiki.contextgarden.net/PDF/A

2682−[`setupwhitespace`]: https://wiki.contextgarden.net/Command/setupwhitespace

2683−[`setupinterlinespace`]: https://wiki.contextgarden.net/Command/setupinterlinespace

2684−[`setuppagenumbering`]: https://wiki.contextgarden.net/Command/setuppagenumbering

2032+As with setext-style headers, the header text can contain formatting:

26852033

2686−### Variables for `wkhtmltopdf`

2034+ # A level-one header with a [link](/url) and *emphasis*

26872035

2688−Pandoc uses these variables when [creating a PDF] with [`wkhtmltopdf`].

2689−The `--css` option also affects the output.

2036+#### Extension: `blank_before_header` ####

26902037

2691−`footer-html`, `header-html`

2692−: add information to the header and footer

2038+Standard Markdown syntax does not require a blank line before a header.

2039+Pandoc does require this (except, of course, at the beginning of the

2040+document). The reason for the requirement is that it is all too easy for a

2041+`#` to end up at the beginning of a line by accident (perhaps through line

2042+wrapping). Consider, for example:

26932043

2694−`margin-left`, `margin-right`, `margin-top`, `margin-bottom`

2695−: set the page margins

2044+ I like several of their flavors of ice cream:

2045+ #22, for example, and #5.

26962046

2697−`papersize`

2698−: sets the PDF paper size

2047+#### Extension: `space_in_atx_header` ####

26992048

2700−### Variables for man pages

2049+Many Markdown implementations do not require a space between the

2050+opening `#`s of an ATX header and the header text, so that

2051+`#5 bolt` and `#hashtag` count as headers. With this extension,

2052+pandoc does require the space.

27012053

2702−`adjusting`

2703−: adjusts text to left (`l`), right (`r`), center (`c`),

2704− or both (`b`) margins

2054+### Header identifiers ###

27052055

2706−`footer`

2707−: footer in man pages

2056+See also the [`auto_identifiers` extension](#extension-auto_identifiers) above.

27082057

2709−`header`

2710−: header in man pages

2058+#### Extension: `header_attributes` ####

27112059

2712−`hyphenate`

2713−: if `true` (the default), hyphenation will be used

2060+Headers can be assigned attributes using this syntax at the end

2061+of the line containing the header text:

27142062

2715−`section`

2716−: section number in man pages

2063+ {#identifier .class .class key=value key=value}

27172064

2718−### Variables for ms

2065+Thus, for example, the following headers will all be assigned the identifier

2066+`foo`:

27192067

2720−`fontfamily`

2721−: font family (e.g. `T` or `P`)

2068+ # My header {#foo}

27222069

2723−`indent`

2724−: paragraph indent (e.g. `2m`)

2070+ ## My header ## {#foo}

27252071

2726−`lineheight`

2727−: line height (e.g. `12p`)

2072+ My other header {#foo}

2073+ ---------------

27282074

2729−`pointsize`

2730−: point size (e.g. `10p`)

2075+(This syntax is compatible with [PHP Markdown Extra].)

27312076

2732−### Variables set automatically

2077+Note that although this syntax allows assignment of classes and key/value

2078+attributes, writers generally don't use all of this information. Identifiers,

2079+classes, and key/value attributes are used in HTML and HTML-based formats such

2080+as EPUB and slidy. Identifiers are used for labels and link anchors in the

2081+LaTeX, ConTeXt, Textile, and AsciiDoc writers.

27332082

2734−Pandoc sets these variables automatically in response to [options] or

2735−document contents; users can also modify them. These vary depending

2736−on the output format, and include the following:

2083+Headers with the class `unnumbered` will not be numbered, even if

2084+`--number-sections` is specified. A single hyphen (`-`) in an attribute

2085+context is equivalent to `.unnumbered`, and preferable in non-English

2086+documents. So,

27372087

2738−`body`

2739−: body of document

2088+ # My header {-}

27402089

2741−`date-meta`

2742−: the `date` variable converted to ISO 8601 YYYY-MM-DD,

2743− included in all HTML based formats (dzslides, epub,

2744− html, html4, html5, revealjs, s5, slideous, slidy).

2745− The recognized formats for `date` are: `mm/dd/yyyy`,

2746− `mm/dd/yy`, `yyyy-mm-dd` (ISO 8601), `dd MM yyyy`

2747− (e.g. either `02 Apr 2018` or `02 April 2018`),

2748− `MM dd, yyyy` (e.g. `Apr. 02, 2018` or `April 02, 2018),

2749− `yyyy[mm[dd]]]` (e.g. `20180402, `201804` or `2018`).

2090+is just the same as

27502091

2751−`header-includes`

2752−: contents specified by `-H/--include-in-header` (may have multiple

2753− values)

2092+ # My header {.unnumbered}

27542093

2755−`include-before`

2756−: contents specified by `-B/--include-before-body` (may have

2757− multiple values)

2094+#### Extension: `implicit_header_references` ####

27582095

2759−`include-after`

2760−: contents specified by `-A/--include-after-body` (may have

2761− multiple values)

2096+Pandoc behaves as if reference links have been defined for each header.

2097+So, to link to a header

27622098

2763−`meta-json`

2764−: JSON representation of all of the document's metadata. Field

2765− values are transformed to the selected output format.

2099+ # Header identifiers in HTML

27662100

2767−`numbersections`

2768−: non-null value if `-N/--number-sections` was specified

2101+you can simply write

27692102

2770−`sourcefile`, `outputfile`

2771−: source and destination filenames, as given on the command line.

2772− `sourcefile` can also be a list if input comes from multiple files,

2773− or empty if input is from stdin. You can use the following snippet in

2774− your template to distinguish them:

2103+ [Header identifiers in HTML]

27752104

2776− $if(sourcefile)$

2777− $for(sourcefile)$

2778− $sourcefile$

2779− $endfor$

2780− $else$

2781− (stdin)

2782− $endif$

2105+or

27832106

2784− Similarly, `outputfile` can be `-` if output goes to the terminal.

2107+ [Header identifiers in HTML][]

27852108

2786− If you need absolute paths, use e.g. `$curdir$/$sourcefile$`.

2109+or

27872110

2788−`curdir`

2789−: working directory from which pandoc is run.

2111+ [the section on header identifiers][header identifiers in

2112+ HTML]

27902113

2791−`toc`

2792−: non-null value if `--toc/--table-of-contents` was specified

2114+instead of giving the identifier explicitly:

27932115

2794−`toc-title`

2795−: title of table of contents (works only with EPUB,

2796− HTML, opendocument, odt, docx, pptx, beamer, LaTeX)

2116+ [Header identifiers in HTML](#header-identifiers-in-html)

27972117

2798−[pandoc-templates]: https://github.com/jgm/pandoc-templates

2118+If there are multiple headers with identical text, the corresponding

2119+reference will link to the first one only, and you will need to use explicit

2120+links to link to the others, as described above.

27992121

2800−# Extensions

2122+Like regular reference links, these references are case-insensitive.

28012123

2802−The behavior of some of the readers and writers can be adjusted by

2803−enabling or disabling various extensions.

2124+Explicit link reference definitions always take priority over

2125+implicit header references. So, in the following example, the

2126+link will point to `bar`, not to `#foo`:

28042127

2805−An extension can be enabled by adding `+EXTENSION`

2806−to the format name and disabled by adding `-EXTENSION`. For example,

2807−`--from markdown_strict+footnotes` is strict Markdown with footnotes

2808−enabled, while `--from markdown-footnotes-pipe_tables` is pandoc's

2809−Markdown without footnotes or pipe tables.

2128+ # Foo

28102129

2811−The markdown reader and writer make by far the most use of extensions.

2812−Extensions only used by them are therefore covered in the

2813−section [Pandoc's Markdown] below (See [Markdown variants] for

2814−`commonmark` and `gfm`.) In the following, extensions that also work

2815−for other formats are covered.

2130+ [foo]: bar

28162131

2817−Note that markdown extensions added to the `ipynb` format

2818−affect Markdown cells in Jupyter notebooks (as do command-line

2819−options like `--atx-headers`).

2132+ See [foo]

28202133

2821−## Typography

2134+Block quotations

2135+----------------

28222136

2823−#### Extension: `smart` ####

2137+Markdown uses email conventions for quoting blocks of text.

2138+A block quotation is one or more paragraphs or other block elements

2139+(such as lists or headers), with each line preceded by a `>` character

2140+and an optional space. (The `>` need not start at the left margin, but

2141+it should not be indented more than three spaces.)

28242142

2825−Interpret straight quotes as curly quotes, `---` as em-dashes,

2826−`--` as en-dashes, and `...` as ellipses. Nonbreaking spaces are

2827−inserted after certain abbreviations, such as "Mr."

2828−

2829−This extension can be enabled/disabled for the following formats:

2143+ > This is a block quote. This

2144+ > paragraph has two lines.

2145+ >

2146+ > 1. This is a list inside a block quote.

2147+ > 2. Second item.

28302148

2831−input formats

2832−: `markdown`, `commonmark`, `latex`, `mediawiki`, `org`, `rst`, `twiki`

2149+A "lazy" form, which requires the `>` character only on the first

2150+line of each block, is also allowed:

28332151

2834−output formats

2835−: `markdown`, `latex`, `context`, `rst`

2152+ > This is a block quote. This

2153+ paragraph has two lines.

28362154

2837−enabled by default in

2838−: `markdown`, `latex`, `context` (both input and output)

2155+ > 1. This is a list inside a block quote.

2156+ 2. Second item.

28392157

2840−Note: If you are *writing* Markdown, then the `smart` extension

2841−has the reverse effect: what would have been curly quotes comes

2842−out straight.

2158+Among the block elements that can be contained in a block quote are

2159+other block quotes. That is, block quotes can be nested:

28432160

2844−In LaTeX, `smart` means to use the standard TeX ligatures

2845−for quotation marks (` `` ` and ` '' ` for double quotes,

2846−`` ` `` and `` ' `` for single quotes) and dashes (`--` for

2847−en-dash and `---` for em-dash). If `smart` is disabled,

2848−then in reading LaTeX pandoc will parse these characters

2849−literally. In writing LaTeX, enabling `smart` tells pandoc

2850−to use the ligatures when possible; if `smart` is disabled

2851−pandoc will use unicode quotation mark and dash characters.

2161+ > This is a block quote.

2162+ >

2163+ > > A block quote within a block quote.

28522164

2853−## Headings and sections

2165+If the `>` character is followed by an optional space, that space

2166+will be considered part of the block quote marker and not part of

2167+the indentation of the contents. Thus, to put an indented code

2168+block in a block quote, you need five spaces after the `>`:

28542169

2855−#### Extension: `auto_identifiers` ####

2170+ > code

28562171

2857−A heading without an explicitly specified identifier will be

2858−automatically assigned a unique identifier based on the heading text.

2172+#### Extension: `blank_before_blockquote` ####

28592173

2860−This extension can be enabled/disabled for the following formats:

2174+Standard Markdown syntax does not require a blank line before a block

2175+quote. Pandoc does require this (except, of course, at the beginning of the

2176+document). The reason for the requirement is that it is all too easy for a

2177+`>` to end up at the beginning of a line by accident (perhaps through line

2178+wrapping). So, unless the `markdown_strict` format is used, the following does

2179+not produce a nested block quote in pandoc:

28612180

2862−input formats

2863−: `markdown`, `latex`, `rst`, `mediawiki`, `textile`

2181+ > This is a block quote.

2182+ >> Nested.

28642183

2865−output formats

2866−: `markdown`, `muse`

28672184

2868−enabled by default in

2869−: `markdown`, `muse`

2185+Verbatim (code) blocks

2186+----------------------

28702187

2871−The default algorithm used to derive the identifier from the

2872−heading text is:

2188+### Indented code blocks ###

28732189

2874− - Remove all formatting, links, etc.

2875− - Remove all footnotes.

2876− - Remove all non-alphanumeric characters,

2877− except underscores, hyphens, and periods.

2878− - Replace all spaces and newlines with hyphens.

2879− - Convert all alphabetic characters to lowercase.

2880− - Remove everything up to the first letter (identifiers may

2881− not begin with a number or punctuation mark).

2882− - If nothing is left after this, use the identifier `section`.

2190+A block of text indented four spaces (or one tab) is treated as verbatim

2191+text: that is, special characters do not trigger special formatting,

2192+and all spaces and line breaks are preserved. For example,

28832193

2884−Thus, for example,

2194+ if (a > 3) {

2195+ moveShip(5 * gravity, DOWN);

2196+ }

28852197

2886− Heading Identifier

2887− ------------------------------- ----------------------------

2888− `Heading identifiers in HTML` `heading-identifiers-in-html`

2889− `Maître d'hôtel` `maître-dhôtel`

2890− `*Dogs*?--in *my* house?` `dogs--in-my-house`

2891− `[HTML], [S5], or [RTF]?` `html-s5-or-rtf`

2892− `3. Applications` `applications`

2893− `33` `section`

2198+The initial (four space or one tab) indentation is not considered part

2199+of the verbatim text, and is removed in the output.

28942200

2895−These rules should, in most cases, allow one to determine the identifier

2896−from the heading text. The exception is when several headings have the

2897−same text; in this case, the first will get an identifier as described

2898−above; the second will get the same identifier with `-1` appended; the

2899−third with `-2`; and so on.

2201+Note: blank lines in the verbatim text need not begin with four spaces.

29002202

2901−(However, a different algorithm is used if

2902−`gfm_auto_identifiers` is enabled; see below.)

29032203

2904−These identifiers are used to provide link targets in the table of

2905−contents generated by the `--toc|--table-of-contents` option. They

2906−also make it easy to provide links from one section of a document to

2907−another. A link to this section, for example, might look like this:

2204+### Fenced code blocks ###

29082205

2909− See the section on

2910− [heading identifiers](#heading-identifiers-in-html-latex-and-context).

2206+#### Extension: `fenced_code_blocks` ####

29112207

2912−Note, however, that this method of providing links to sections works

2913−only in HTML, LaTeX, and ConTeXt formats.

2208+In addition to standard indented code blocks, pandoc supports

2209+*fenced* code blocks. These begin with a row of three or more

2210+tildes (`~`) and end with a row of tildes that must be at least as long as

2211+the starting row. Everything between these lines is treated as code. No

2212+indentation is necessary:

29142213

2915−If the `--section-divs` option is specified, then each section will

2916−be wrapped in a `section` (or a `div`, if `html4` was specified),

2917−and the identifier will be attached to the enclosing `<section>`

2918−(or `<div>`) tag rather than the heading itself. This allows entire

2919−sections to be manipulated using JavaScript or treated differently in

2920−CSS.

2214+ ~~~~~~~

2215+ if (a > 3) {

2216+ moveShip(5 * gravity, DOWN);

2217+ }

2218+ ~~~~~~~

29212219

2922−#### Extension: `ascii_identifiers` ####

2220+Like regular code blocks, fenced code blocks must be separated

2221+from surrounding text by blank lines.

29232222

2924−Causes the identifiers produced by `auto_identifiers` to be pure ASCII.

2925−Accents are stripped off of accented Latin letters, and non-Latin

2926−letters are omitted.

2223+If the code itself contains a row of tildes or backticks, just use a longer

2224+row of tildes or backticks at the start and end:

29272225

2928−#### Extension: `gfm_auto_identifiers` ####

2226+ ~~~~~~~~~~~~~~~~

2227+ ~~~~~~~~~~

2228+ code including tildes

2229+ ~~~~~~~~~~

2230+ ~~~~~~~~~~~~~~~~

29292231

2930−Changes the algorithm used by `auto_identifiers` to conform to

2931−GitHub's method. Spaces are converted to dashes (`-`),

2932−uppercase characters to lowercase characters, and punctuation

2933−characters other than `-` and `_` are removed.

2934−Emojis are replaced by their names.

2232+#### Extension: `backtick_code_blocks` ####

29352233

2936−## Math Input

2234+Same as `fenced_code_blocks`, but uses backticks (`` ` ``) instead of tildes

2235+(`~`).

29372236

2938−The extensions [`tex_math_dollars`](#extension-tex_math_dollars),

2939−[`tex_math_single_backslash`](#extension-tex_math_single_backslash), and

2940−[`tex_math_double_backslash`](#extension-tex_math_double_backslash)

2941−are described in the section about Pandoc's Markdown.

2237+#### Extension: `fenced_code_attributes` ####

29422238

2943−However, they can also be used with HTML input. This is handy for

2944−reading web pages formatted using MathJax, for example.

2239+Optionally, you may attach attributes to fenced or backtick code block using

2240+this syntax:

29452241

2946−## Raw HTML/TeX

2242+ ~~~~ {#mycode .haskell .numberLines startFrom="100"}

2243+ qsort [] = []

2244+ qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++

2245+ qsort (filter (>= x) xs)

2246+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

29472247

2948−The following extensions are described in more detail in

2949−their respective sections of [Pandoc's Markdown]:

2248+Here `mycode` is an identifier, `haskell` and `numberLines` are classes, and

2249+`startFrom` is an attribute with value `100`. Some output formats can use this

2250+information to do syntax highlighting. Currently, the only output formats

2251+that uses this information are HTML, LaTeX, Docx, and Ms. If highlighting

2252+is supported for your output format and language, then the code block above

2253+will appear highlighted, with numbered lines. (To see which languages are

2254+supported, type `pandoc --list-highlight-languages`.) Otherwise, the code

2255+block above will appear as follows:

29502256

2951−- [`raw_html`](#extension-raw_html) allows HTML elements which

2952− are not representable in pandoc's AST to be parsed as raw HTML.

2953− By default, this is disabled for HTML input.

2257+ <pre id="mycode" class="haskell numberLines" startFrom="100">

2258+ <code>

2259+ ...

2260+ </code>

2261+ </pre>

29542262

2955−- [`raw_tex`](#extension-raw_tex) allows raw LaTeX, TeX, and ConTeXt

2956− to be included in a document. This extension can be enabled/disabled

2957− for the following formats (in addition to `markdown`):

2263+The `numberLines` (or `number-lines`) class will cause the lines

2264+of the code block to be numbered, starting with `1` or the value

2265+of the `startFrom` attribute. The `lineAnchors` (or

2266+`line-anchors`) class will cause the lines to be clickable

2267+anchors in HTML output.

29582268

2959− input formats

2960− : `latex`, `textile`, `html` (environments, `\ref`, and

2961− `\eqref` only), `ipynb`

2269+A shortcut form can also be used for specifying the language of

2270+the code block:

29622271

2963− output formats

2964− : `textile`, `commonmark`

2272+ ```haskell

2273+ qsort [] = []

2274+ ```

29652275

2966− Note: as applied to `ipynb`, `raw_html` and `raw_tex` affect not

2967− only raw TeX in markdown cells, but data with mime type

2968− `text/html` in output cells. Since the `ipynb` reader attempts

2969− to preserve the richest possible outputs when several options

2970− are given, you will get best results if you disable `raw_html`

2971− and `raw_tex` when converting to formats like `docx` which don't

2972− allow raw `html` or `tex`.

2276+This is equivalent to:

29732277

2974−- [`native_divs`](#extension-native_divs) causes HTML `div`

2975− elements to be parsed as native pandoc Div blocks.

2976− If you want them to be parsed as raw HTML, use

2977− `-f html-native_divs+raw_html`.

2278+ ``` {.haskell}

2279+ qsort [] = []

2280+ ```

29782281

2979−- [`native_spans`](#extension-native_spans) causes HTML `span`

2980− elements to be parsed as native pandoc Span inlines.

2981− If you want them to be parsed as raw HTML, use

2982− `-f html-native_spans+raw_html`. If you want to drop all

2983− `div`s and `span`s when converting HTML to Markdown, you

2984− can use `pandoc -f html-native_divs-native_spans -t markdown`.

2282+If the `fenced_code_attributes` extension is disabled, but

2283+input contains class attribute(s) for the code block, the first

2284+class attribute will be printed after the opening fence as a bare

2285+word.

29852286

2986−## Literate Haskell support

2287+To prevent all highlighting, use the `--no-highlight` flag.

2288+To set the highlighting style, use `--highlight-style`.

2289+For more information on highlighting, see [Syntax highlighting],

2290+below.

29872291

2988−#### Extension: `literate_haskell` ####

2292+Line blocks

2293+-----------

29892294

2990−Treat the document as literate Haskell source.

2295+#### Extension: `line_blocks` ####

29912296

2992−This extension can be enabled/disabled for the following formats:

2297+A line block is a sequence of lines beginning with a vertical bar (`|`)

2298+followed by a space. The division into lines will be preserved in

2299+the output, as will any leading spaces; otherwise, the lines will

2300+be formatted as Markdown. This is useful for verse and addresses:

29932301

2994−input formats

2995−: `markdown`, `rst`, `latex`

2302+ | The limerick packs laughs anatomical

2303+ | In space that is quite economical.

2304+ | But the good ones I've seen

2305+ | So seldom are clean

2306+ | And the clean ones so seldom are comical

29962307

2997−output formats

2998−: `markdown`, `rst`, `latex`, `html`

2308+ | 200 Main St.

2309+ | Berkeley, CA 94718

29992310

3000−If you append `+lhs` (or `+literate_haskell`) to one of the formats

3001−above, pandoc will treat the document as literate Haskell source.

3002−This means that

2311+The lines can be hard-wrapped if needed, but the continuation

2312+line must begin with a space.

30032313

3004− - In Markdown input, "bird track" sections will be parsed as Haskell

3005− code rather than block quotations. Text between `\begin{code}`

3006− and `\end{code}` will also be treated as Haskell code. For

3007− ATX-style headings the character '=' will be used instead of '#'.

2314+ | The Right Honorable Most Venerable and Righteous Samuel L.

2315+ Constable, Jr.

2316+ | 200 Main St.

2317+ | Berkeley, CA 94718

30082318

3009− - In Markdown output, code blocks with classes `haskell` and `literate`

3010− will be rendered using bird tracks, and block quotations will be

3011− indented one space, so they will not be treated as Haskell code.

3012− In addition, headings will be rendered setext-style (with underlines)

3013− rather than ATX-style (with '#' characters). (This is because ghc

3014− treats '#' characters in column 1 as introducing line numbers.)

2319+This syntax is borrowed from [reStructuredText].

30152320

3016− - In restructured text input, "bird track" sections will be parsed

3017− as Haskell code.

2321+Lists

2322+-----

30182323

3019− - In restructured text output, code blocks with class `haskell` will

3020− be rendered using bird tracks.

2324+### Bullet lists ###

30212325

3022− - In LaTeX input, text in `code` environments will be parsed as

3023− Haskell code.

2326+A bullet list is a list of bulleted list items. A bulleted list

2327+item begins with a bullet (`*`, `+`, or `-`). Here is a simple

2328+example:

30242329

3025− - In LaTeX output, code blocks with class `haskell` will be rendered

3026− inside `code` environments.

2330+ * one

2331+ * two

2332+ * three

30272333

3028− - In HTML output, code blocks with class `haskell` will be rendered

3029− with class `literatehaskell` and bird tracks.

2334+This will produce a "compact" list. If you want a "loose" list, in which

2335+each item is formatted as a paragraph, put spaces between the items:

30302336

3031−Examples:

2337+ * one

30322338

3033− pandoc -f markdown+lhs -t html

2339+ * two

30342340

3035−reads literate Haskell source formatted with Markdown conventions and writes

3036−ordinary HTML (without bird tracks).

2341+ * three

30372342

3038− pandoc -f markdown+lhs -t html+lhs

2343+The bullets need not be flush with the left margin; they may be

2344+indented one, two, or three spaces. The bullet must be followed

2345+by whitespace.

30392346

3040−writes HTML with the Haskell code in bird tracks, so it can be copied

3041−and pasted as literate Haskell source.

2347+List items look best if subsequent lines are flush with the first

2348+line (after the bullet):

30422349

3043−Note that GHC expects the bird tracks in the first column, so indented

3044−literate code blocks (e.g. inside an itemized environment) will not be

3045−picked up by the Haskell compiler.

2350+ * here is my first

2351+ list item.

2352+ * and my second.

30462353

3047−## Other extensions

2354+But Markdown also allows a "lazy" format:

30482355

3049−#### Extension: `empty_paragraphs` ####

2356+ * here is my first

2357+ list item.

2358+ * and my second.

30502359

3051−Allows empty paragraphs. By default empty paragraphs are

3052−omitted.

2360+### Block content in list items ###

30532361

3054−This extension can be enabled/disabled for the following formats:

2362+A list item may contain multiple paragraphs and other block-level

2363+content. However, subsequent paragraphs must be preceded by a blank line

2364+and indented to line up with the first non-space content after

2365+the list marker.

30552366

3056−input formats

3057−: `docx`, `html`

2367+ * First paragraph.

30582368

3059−output formats

3060−: `docx`, `odt`, `opendocument`, `html`

2369+ Continued.

30612370

3062−#### Extension: `native_numbering` ####

2371+ * Second paragraph. With a code block, which must be indented

2372+ eight spaces:

30632373

3064−Enables native numbering of figures and tables. Enumeration

3065−starts at 1.

2374+ { code }

30662375

3067−This extension can be enabled/disabled for the following formats:

3068−

3069−output formats

3070−: `odt`, `opendocument`

2376+Exception: if the list marker is followed by an indented code

2377+block, which must begin 5 spaces after the list marker, then

2378+subsequent paragraphs must begin two columns after the last

2379+character of the list marker:

30712380

3072−#### Extension: `xrefs_name` ####

2381+ * code

30732382

3074−Links to headings, figures and tables inside the document are

3075−substituted with cross-references that will use the name or caption

3076−of the referenced item. The original link text is replaced once

3077−the generated document is refreshed. This extension can be combined

3078−with `xrefs_number` in which case numbers will appear before the

3079−name.

2383+ continuation paragraph

30802384

3081−Text in cross-references is only made consistent with the referenced

3082−item once the document has been refreshed.

2385+List items may include other lists. In this case the preceding blank

2386+line is optional. The nested list must be indented to line up with

2387+the first non-space character after the list marker of the

2388+containing list item.

30832389

3084−This extension can be enabled/disabled for the following formats:

2390+ * fruits

2391+ + apples

2392+ - macintosh

2393+ - red delicious

2394+ + pears

2395+ + peaches

2396+ * vegetables

2397+ + broccoli

2398+ + chard

30852399

3086−output formats

3087−: `odt`, `opendocument`

2400+As noted above, Markdown allows you to write list items "lazily," instead of

2401+indenting continuation lines. However, if there are multiple paragraphs or

2402+other blocks in a list item, the first line of each must be indented.

30882403

3089−#### Extension: `xrefs_number` ####

2404+ + A lazy, lazy, list

2405+ item.

30902406

3091−Links to headings, figures and tables inside the document are

3092−substituted with cross-references that will use the number

3093−of the referenced item. The original link text is discarded.

3094−This extension can be combined with `xrefs_name` in which case

3095−the name or caption numbers will appear after the number.

2407+ + Another one; this looks

2408+ bad but is legal.

30962409

3097−For the `xrefs_number` to be useful heading numbers must be enabled

3098−in the generated document, also table and figure captions must be enabled

3099−using for example the `native_numbering` extension.

2410+ Second paragraph of second

2411+ list item.

31002412

3101−Numbers in cross-references are only visible in the final document once

3102−it has been refreshed.

2413+### Ordered lists ###

31032414

3104−This extension can be enabled/disabled for the following formats:

2415+Ordered lists work just like bulleted lists, except that the items

2416+begin with enumerators rather than bullets.

31052417

3106−output formats

3107−: `odt`, `opendocument`

2418+In standard Markdown, enumerators are decimal numbers followed

2419+by a period and a space. The numbers themselves are ignored, so

2420+there is no difference between this list:

31082421

3109−#### Extension: `styles` #### {#ext-styles}

2422+ 1. one

2423+ 2. two

2424+ 3. three

31102425

3111−When converting from docx, read all docx styles as divs (for

3112−paragraph styles) and spans (for character styles) regardless

3113−of whether pandoc understands the meaning of these styles.

3114−This can be used with [docx custom styles](#custom-styles).

3115−Disabled by default.

2426+and this one:

31162427

3117−input formats

3118−: `docx`

2428+ 5. one

2429+ 7. two

2430+ 1. three

31192431

3120−#### Extension: `amuse` ####

2432+#### Extension: `fancy_lists` ####

31212433

3122−In the `muse` input format, this enables Text::Amuse

3123−extensions to Emacs Muse markup.

2434+Unlike standard Markdown, pandoc allows ordered list items to be marked

2435+with uppercase and lowercase letters and roman numerals, in addition to

2436+Arabic numerals. List markers may be enclosed in parentheses or followed by a

2437+single right-parentheses or period. They must be separated from the

2438+text that follows by at least one space, and, if the list marker is a

2439+capital letter with a period, by at least two spaces.[^2]

31242440

3125−#### Extension: `raw_markdown` ####

2441+[^2]: The point of this rule is to ensure that normal paragraphs

2442+ starting with people's initials, like

31262443

3127−In the `ipynb` input format, this causes Markdown cells

3128−to be included as raw Markdown blocks (allowing lossless

3129−round-tripping) rather than being parsed. Use this only

3130−when you are targeting `ipynb` or a markdown-based

3131−output format.

2444+ B. Russell was an English philosopher.

31322445

3133−#### Extension: `citations` {#org-citations}

2446+ do not get treated as list items.

31342447

3135−Some aspects of [Pandoc's Markdown citation syntax](#citations)

3136−are also accepted in `org` input.

2448+ This rule will not prevent

31372449

3138−#### Extension: `element_citations` ####

2450+ (C) 2007 Joe Smith

31392451

3140−In the `jats` output formats, this causes reference items to

3141−be replaced with `<element-citation>` elements. These

3142−elements are not influenced by CSL styles, but all information

3143−on the item is included in tags.

2452+ from being interpreted as a list item. In this case, a backslash

2453+ escape can be used:

31442454

3145−#### Extension: `ntb` ####

2455+ (C\) 2007 Joe Smith

31462456

3147−In the `context` output format this enables the use of [Natural Tables

3148−(TABLE)](https://wiki.contextgarden.net/TABLE) instead of the default

3149−[Extreme Tables (xtables)](https://wiki.contextgarden.net/xtables).

3150−Natural tables allow more fine-grained global customization but come

3151−at a performance penalty compared to extreme tables.

2457+The `fancy_lists` extension also allows '`#`' to be used as an

2458+ordered list marker in place of a numeral:

31522459

2460+ #. one

2461+ #. two

31532462

3154−# Pandoc's Markdown

2463+#### Extension: `startnum` ####

31552464

3156−Pandoc understands an extended and slightly revised version of

3157−John Gruber's [Markdown] syntax. This document explains the syntax,

3158−noting differences from standard Markdown. Except where noted, these

3159−differences can be suppressed by using the `markdown_strict` format instead

3160−of `markdown`. Extensions can be enabled or disabled to specify the

3161−behavior more granularly. They are described in the following. See also

3162−[Extensions] above, for extensions that work also on other formats.

2465+Pandoc also pays attention to the type of list marker used, and to the

2466+starting number, and both of these are preserved where possible in the

2467+output format. Thus, the following yields a list with numbers followed

2468+by a single parenthesis, starting with 9, and a sublist with lowercase

2469+roman numerals:

31632470

3164−## Philosophy

2471+ 9) Ninth

2472+ 10) Tenth

2473+ 11) Eleventh

2474+ i. subone

2475+ ii. subtwo

2476+ iii. subthree

31652477

3166−Markdown is designed to be easy to write, and, even more importantly,

3167−easy to read:

2478+Pandoc will start a new list each time a different type of list

2479+marker is used. So, the following will create three lists:

31682480

3169−> A Markdown-formatted document should be publishable as-is, as plain

3170−> text, without looking like it's been marked up with tags or formatting

3171−> instructions.

3172−> -- [John Gruber](https://daringfireball.net/projects/markdown/syntax#philosophy)

2481+ (2) Two

2482+ (5) Three

2483+ 1. Four

2484+ * Five

31732485

3174−This principle has guided pandoc's decisions in finding syntax for

3175−tables, footnotes, and other extensions.

2486+If default list markers are desired, use `#.`:

31762487

3177−There is, however, one respect in which pandoc's aims are different

3178−from the original aims of Markdown. Whereas Markdown was originally

3179−designed with HTML generation in mind, pandoc is designed for multiple

3180−output formats. Thus, while pandoc allows the embedding of raw HTML,

3181−it discourages it, and provides other, non-HTMLish ways of representing

3182−important document elements like definition lists, tables, mathematics, and

3183−footnotes.

2488+ #. one

2489+ #. two

2490+ #. three

31842491

3185−## Paragraphs

31862492

3187−A paragraph is one or more lines of text followed by one or more blank lines.

3188−Newlines are treated as spaces, so you can reflow your paragraphs as you like.

3189−If you need a hard line break, put two or more spaces at the end of a line.

2493+### Definition lists ###

31902494

3191−#### Extension: `escaped_line_breaks` ####

2495+#### Extension: `definition_lists` ####

31922496

3193−A backslash followed by a newline is also a hard line break.

3194−Note: in multiline and grid table cells, this is the only way

3195−to create a hard line break, since trailing spaces in the cells

3196−are ignored.

2497+Pandoc supports definition lists, using the syntax of

2498+[PHP Markdown Extra] with some extensions.[^3]

31972499

3198−## Headings

2500+ Term 1

31992501

3200−There are two kinds of headings: Setext and ATX.

2502+ : Definition 1

32012503

3202−### Setext-style headings ###

2504+ Term 2 with *inline markup*

32032505

3204−A setext-style heading is a line of text "underlined" with a row of `=` signs

3205−(for a level-one heading) or `-` signs (for a level-two heading):

2506+ : Definition 2

32062507

3207− A level-one heading

3208− ===================

2508+ { some code, part of Definition 2 }

32092509

3210− A level-two heading

3211− -------------------

2510+ Third paragraph of definition 2.

32122511

3213−The heading text can contain inline formatting, such as emphasis (see

3214−[Inline formatting], below).

2512+Each term must fit on one line, which may optionally be followed by

2513+a blank line, and must be followed by one or more definitions.

2514+A definition begins with a colon or tilde, which may be indented one

2515+or two spaces.

32152516

2517+A term may have multiple definitions, and each definition may consist of one or

2518+more block elements (paragraph, code block, list, etc.), each indented four

2519+spaces or one tab stop. The body of the definition (including the first line,

2520+aside from the colon or tilde) should be indented four spaces. However,

2521+as with other Markdown lists, you can "lazily" omit indentation except

2522+at the beginning of a paragraph or other block element:

32162523

3217−### ATX-style headings ###

2524+ Term 1

32182525

3219−An ATX-style heading consists of one to six `#` signs and a line of

3220−text, optionally followed by any number of `#` signs. The number of

3221−`#` signs at the beginning of the line is the heading level:

2526+ : Definition

2527+ with lazy continuation.

32222528

3223− ## A level-two heading

2529+ Second paragraph of the definition.

32242530

3225− ### A level-three heading ###

2531+If you leave space before the definition (as in the example above),

2532+the text of the definition will be treated as a paragraph. In some

2533+output formats, this will mean greater spacing between term/definition

2534+pairs. For a more compact definition list, omit the space before the

2535+definition:

32262536

3227−As with setext-style headings, the heading text can contain formatting:

2537+ Term 1

2538+ ~ Definition 1

32282539

3229− # A level-one heading with a [link](/url) and *emphasis*

2540+ Term 2

2541+ ~ Definition 2a

2542+ ~ Definition 2b

32302543

3231−#### Extension: `blank_before_header` ####

2544+Note that space between items in a definition list is required.

2545+(A variant that loosens this requirement, but disallows "lazy"

2546+hard wrapping, can be activated with `compact_definition_lists`: see

2547+[Non-pandoc extensions], below.)

32322548

3233−Standard Markdown syntax does not require a blank line before a heading.

3234−Pandoc does require this (except, of course, at the beginning of the

3235−document). The reason for the requirement is that it is all too easy for a

3236−`#` to end up at the beginning of a line by accident (perhaps through line

3237−wrapping). Consider, for example:

2549+[^3]: I have been influenced by the suggestions of [David Wheeler](http://www.justatheory.com/computers/markup/modest-markdown-proposal.html).

32382550

3239− I like several of their flavors of ice cream:

3240− #22, for example, and #5.

2551+### Numbered example lists ###

32412552

3242−#### Extension: `space_in_atx_header` ####

2553+#### Extension: `example_lists` ####

32432554

3244−Many Markdown implementations do not require a space between the

3245−opening `#`s of an ATX heading and the heading text, so that

3246−`#5 bolt` and `#hashtag` count as headings. With this extension,

3247−pandoc does require the space.

2555+The special list marker `@` can be used for sequentially numbered

2556+examples. The first list item with a `@` marker will be numbered '1',

2557+the next '2', and so on, throughout the document. The numbered examples

2558+need not occur in a single list; each new list using `@` will take up

2559+where the last stopped. So, for example:

32482560

3249−### Heading identifiers ###

2561+ (@) My first example will be numbered (1).

2562+ (@) My second example will be numbered (2).

32502563

3251−See also the [`auto_identifiers`

3252−extension](#extension-auto_identifiers) above.

2564+ Explanation of examples.

32532565

3254−#### Extension: `header_attributes` ####

2566+ (@) My third example will be numbered (3).

32552567

3256−Headings can be assigned attributes using this syntax at the end

3257−of the line containing the heading text:

2568+Numbered examples can be labeled and referred to elsewhere in the

2569+document:

32582570

3259− {#identifier .class .class key=value key=value}

2571+ (@good) This is a good example.

32602572

3261−Thus, for example, the following headings will all be assigned the identifier

3262−`foo`:

2573+ As (@good) illustrates, ...

32632574

3264− # My heading {#foo}

2575+The label can be any string of alphanumeric characters, underscores,

2576+or hyphens.

32652577

3266− ## My heading ## {#foo}

2578+Note: continuation paragraphs in example lists must always

2579+be indented four spaces, regardless of the length of the

2580+list marker. That is, example lists always behave as if the

2581+`four_space_rule` extension is set. This is because example

2582+labels tend to be long, and indenting content to the

2583+first non-space character after the label would be awkward.

32672584

3268− My other heading {#foo}

3269− ---------------

2585+### Compact and loose lists ###

32702586

3271−(This syntax is compatible with [PHP Markdown Extra].)

2587+Pandoc behaves differently from `Markdown.pl` on some "edge

2588+cases" involving lists. Consider this source:

32722589

3273−Note that although this syntax allows assignment of classes and key/value

3274−attributes, writers generally don't use all of this information. Identifiers,

3275−classes, and key/value attributes are used in HTML and HTML-based formats such

3276−as EPUB and slidy. Identifiers are used for labels and link anchors in the

3277−LaTeX, ConTeXt, Textile, Jira markup, and AsciiDoc writers.

2590+ + First

2591+ + Second:

2592+ - Fee

2593+ - Fie

2594+ - Foe

32782595

3279−Headings with the class `unnumbered` will not be numbered, even if

3280−`--number-sections` is specified. A single hyphen (`-`) in an attribute

3281−context is equivalent to `.unnumbered`, and preferable in non-English

3282−documents. So,

2596+ + Third

32832597

3284− # My heading {-}

2598+Pandoc transforms this into a "compact list" (with no `<p>` tags around

2599+"First", "Second", or "Third"), while Markdown puts `<p>` tags around

2600+"Second" and "Third" (but not "First"), because of the blank space

2601+around "Third". Pandoc follows a simple rule: if the text is followed by

2602+a blank line, it is treated as a paragraph. Since "Second" is followed

2603+by a list, and not a blank line, it isn't treated as a paragraph. The

2604+fact that the list is followed by a blank line is irrelevant. (Note:

2605+Pandoc works this way even when the `markdown_strict` format is specified. This

2606+behavior is consistent with the official Markdown syntax description,

2607+even though it is different from that of `Markdown.pl`.)

32852608

3286−is just the same as

32872609

3288− # My heading {.unnumbered}

2610+### Ending a list ###

32892611

3290−If the `unlisted` class is present in addition to `unnumbered`,

3291−the heading will not be included in a table of contents.

3292−(Currently this feature is only implemented for certain

3293−formats: those based on LaTeX and HTML, PowerPoint, and RTF.)

2612+What if you want to put an indented code block after a list?

32942613

3295−#### Extension: `implicit_header_references` ####

2614+ - item one

2615+ - item two

32962616

3297−Pandoc behaves as if reference links have been defined for each heading.

3298−So, to link to a heading

2617+ { my code block }

32992618

3300− # Heading identifiers in HTML

2619+Trouble! Here pandoc (like other Markdown implementations) will treat

2620+`{ my code block }` as the second paragraph of item two, and not as

2621+a code block.

33012622

3302−you can simply write

2623+To "cut off" the list after item two, you can insert some non-indented

2624+content, like an HTML comment, which won't produce visible output in

2625+any format:

33032626

3304− [Heading identifiers in HTML]

2627+ - item one

2628+ - item two

33052629

3306−or

2630+ <!-- end of list -->

33072631

3308− [Heading identifiers in HTML][]

2632+ { my code block }

33092633

3310−or

2634+You can use the same trick if you want two consecutive lists instead

2635+of one big list:

33112636

3312− [the section on heading identifiers][heading identifiers in

3313− HTML]

2637+ 1. one

2638+ 2. two

2639+ 3. three

33142640

3315−instead of giving the identifier explicitly:

2641+ <!-- -->

33162642

3317− [Heading identifiers in HTML](#heading-identifiers-in-html)

2643+ 1. uno

2644+ 2. dos

2645+ 3. tres

33182646

3319−If there are multiple headings with identical text, the corresponding

3320−reference will link to the first one only, and you will need to use explicit

3321−links to link to the others, as described above.

2647+Horizontal rules

2648+----------------

33222649

3323−Like regular reference links, these references are case-insensitive.

2650+A line containing a row of three or more `*`, `-`, or `_` characters

2651+(optionally separated by spaces) produces a horizontal rule:

33242652

3325−Explicit link reference definitions always take priority over

3326−implicit heading references. So, in the following example, the

3327−link will point to `bar`, not to `#foo`:

2653+ * * * *

33282654

3329− # Foo

2655+ ---------------

33302656

3331− [foo]: bar

33322657

3333− See [foo]

2658+Tables

2659+------

33342660

3335−## Block quotations

2661+Four kinds of tables may be used. The first three kinds presuppose the use of

2662+a fixed-width font, such as Courier. The fourth kind can be used with

2663+proportionally spaced fonts, as it does not require lining up columns.

33362664

3337−Markdown uses email conventions for quoting blocks of text.

3338−A block quotation is one or more paragraphs or other block elements

3339−(such as lists or headings), with each line preceded by a `>` character

3340−and an optional space. (The `>` need not start at the left margin, but

3341−it should not be indented more than three spaces.)

2665+#### Extension: `table_captions` ####

33422666

3343− > This is a block quote. This

3344− > paragraph has two lines.

3345− >

3346− > 1. This is a list inside a block quote.

3347− > 2. Second item.

3348−

3349−A "lazy" form, which requires the `>` character only on the first

3350−line of each block, is also allowed:

3351−

3352− > This is a block quote. This

3353− paragraph has two lines.

3354−

3355− > 1. This is a list inside a block quote.

3356− 2. Second item.

3357−

3358−Among the block elements that can be contained in a block quote are

3359−other block quotes. That is, block quotes can be nested:

3360−

3361− > This is a block quote.

3362− >

3363− > > A block quote within a block quote.

3364−

3365−If the `>` character is followed by an optional space, that space

3366−will be considered part of the block quote marker and not part of

3367−the indentation of the contents. Thus, to put an indented code

3368−block in a block quote, you need five spaces after the `>`:

3369−

3370− > code

3371−

3372−#### Extension: `blank_before_blockquote` ####

3373−

3374−Standard Markdown syntax does not require a blank line before a

3375−block quote. Pandoc does require this (except, of course, at

3376−the beginning of the document). The reason for the requirement

3377−is that it is all too easy for a `>` to end up at the beginning

3378−of a line by accident (perhaps through line wrapping). So,

3379−unless the `markdown_strict` format is used, the following does

3380−not produce a nested block quote in pandoc:

3381−

3382− > This is a block quote.

3383− >> Nested.

3384−

3385−

3386−## Verbatim (code) blocks

3387−

3388−### Indented code blocks ###

3389−

3390−A block of text indented four spaces (or one tab) is treated as verbatim

3391−text: that is, special characters do not trigger special formatting,

3392−and all spaces and line breaks are preserved. For example,

3393−

3394− if (a > 3) {

3395− moveShip(5 * gravity, DOWN);

3396− }

3397−

3398−The initial (four space or one tab) indentation is not considered part

3399−of the verbatim text, and is removed in the output.

3400−

3401−Note: blank lines in the verbatim text need not begin with four spaces.

3402−

3403−

3404−### Fenced code blocks ###

3405−

3406−#### Extension: `fenced_code_blocks` ####

3407−

3408−In addition to standard indented code blocks, pandoc supports

3409−*fenced* code blocks. These begin with a row of three or more

3410−tildes (`~`) and end with a row of tildes that must be at least as long as

3411−the starting row. Everything between these lines is treated as code. No

3412−indentation is necessary:

3413−

3414− ~~~~~~~

3415− if (a > 3) {

3416− moveShip(5 * gravity, DOWN);

3417− }

3418− ~~~~~~~

3419−

3420−Like regular code blocks, fenced code blocks must be separated

3421−from surrounding text by blank lines.

3422−

3423−If the code itself contains a row of tildes or backticks, just use a longer

3424−row of tildes or backticks at the start and end:

3425−

3426− ~~~~~~~~~~~~~~~~

3427− ~~~~~~~~~~

3428− code including tildes

3429− ~~~~~~~~~~

3430− ~~~~~~~~~~~~~~~~

3431−

3432−#### Extension: `backtick_code_blocks` ####

3433−

3434−Same as `fenced_code_blocks`, but uses backticks (`` ` ``) instead of tildes

3435−(`~`).

3436−

3437−#### Extension: `fenced_code_attributes` ####

3438−

3439−Optionally, you may attach attributes to fenced or backtick code block using

3440−this syntax:

3441−

3442− ~~~~ {#mycode .haskell .numberLines startFrom="100"}

3443− qsort [] = []

3444− qsort (x:xs) = qsort (filter (< x) xs) ++ [x] ++

3445− qsort (filter (>= x) xs)

3446− ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

3447−

3448−Here `mycode` is an identifier, `haskell` and `numberLines` are

3449−classes, and `startFrom` is an attribute with value `100`. Some

3450−output formats can use this information to do syntax

3451−highlighting. Currently, the only output formats that uses this

3452−information are HTML, LaTeX, Docx, Ms, and PowerPoint. If

3453−highlighting is supported for your output format and language,

3454−then the code block above will appear highlighted, with numbered

3455−lines. (To see which languages are supported, type `pandoc

3456−--list-highlight-languages`.) Otherwise, the code block above

3457−will appear as follows:

3458−

3459− <pre id="mycode" class="haskell numberLines" startFrom="100">

3460− <code>

3461− ...

3462− </code>

3463− </pre>

3464−

3465−The `numberLines` (or `number-lines`) class will cause the lines

3466−of the code block to be numbered, starting with `1` or the value

3467−of the `startFrom` attribute. The `lineAnchors` (or

3468−`line-anchors`) class will cause the lines to be clickable

3469−anchors in HTML output.

3470−

3471−A shortcut form can also be used for specifying the language of

3472−the code block:

3473−

3474− ```haskell

3475− qsort [] = []

3476− ```

3477−

3478−This is equivalent to:

3479−

3480− ``` {.haskell}

3481− qsort [] = []

3482− ```

3483−

3484−If the `fenced_code_attributes` extension is disabled, but

3485−input contains class attribute(s) for the code block, the first

3486−class attribute will be printed after the opening fence as a bare

3487−word.

3488−

3489−To prevent all highlighting, use the `--no-highlight` flag.

3490−To set the highlighting style, use `--highlight-style`.

3491−For more information on highlighting, see [Syntax highlighting],

3492−below.

3493−

3494−## Line blocks

3495−

3496−#### Extension: `line_blocks` ####

3497−

3498−A line block is a sequence of lines beginning with a vertical bar (`|`)

3499−followed by a space. The division into lines will be preserved in

3500−the output, as will any leading spaces; otherwise, the lines will

3501−be formatted as Markdown. This is useful for verse and addresses:

3502−

3503− | The limerick packs laughs anatomical

3504− | In space that is quite economical.

3505− | But the good ones I've seen

3506− | So seldom are clean

3507− | And the clean ones so seldom are comical

3508−

3509− | 200 Main St.

3510− | Berkeley, CA 94718

3511−

3512−The lines can be hard-wrapped if needed, but the continuation

3513−line must begin with a space.

3514−

3515− | The Right Honorable Most Venerable and Righteous Samuel L.

3516− Constable, Jr.

3517− | 200 Main St.

3518− | Berkeley, CA 94718

3519−

3520−Inline formatting (such as emphasis) is allowed in the content,

3521−but not block-level formatting (such as block quotes or lists).

3522−

3523−This syntax is borrowed from [reStructuredText].

3524−

3525−## Lists

3526−

3527−### Bullet lists ###

3528−

3529−A bullet list is a list of bulleted list items. A bulleted list

3530−item begins with a bullet (`*`, `+`, or `-`). Here is a simple

3531−example:

3532−

3533− * one

3534− * two

3535− * three

3536−

3537−This will produce a "compact" list. If you want a "loose" list, in which

3538−each item is formatted as a paragraph, put spaces between the items:

3539−

3540− * one

3541−

3542− * two

3543−

3544− * three

3545−

3546−The bullets need not be flush with the left margin; they may be

3547−indented one, two, or three spaces. The bullet must be followed

3548−by whitespace.

3549−

3550−List items look best if subsequent lines are flush with the first

3551−line (after the bullet):

3552−

3553− * here is my first

3554− list item.

3555− * and my second.

3556−

3557−But Markdown also allows a "lazy" format:

3558−

3559− * here is my first

3560− list item.

3561− * and my second.

3562−

3563−### Block content in list items ###

3564−

3565−A list item may contain multiple paragraphs and other block-level

3566−content. However, subsequent paragraphs must be preceded by a blank line

3567−and indented to line up with the first non-space content after

3568−the list marker.

3569−

3570− * First paragraph.

3571−

3572− Continued.

3573−

3574− * Second paragraph. With a code block, which must be indented

3575− eight spaces:

3576−

3577− { code }

3578−

3579−Exception: if the list marker is followed by an indented code

3580−block, which must begin 5 spaces after the list marker, then

3581−subsequent paragraphs must begin two columns after the last

3582−character of the list marker:

3583−

3584− * code

3585−

3586− continuation paragraph

3587−

3588−List items may include other lists. In this case the preceding blank

3589−line is optional. The nested list must be indented to line up with

3590−the first non-space character after the list marker of the

3591−containing list item.

3592−

3593− * fruits

3594− + apples

3595− - macintosh

3596− - red delicious

3597− + pears

3598− + peaches

3599− * vegetables

3600− + broccoli

3601− + chard

3602−

3603−As noted above, Markdown allows you to write list items "lazily," instead of

3604−indenting continuation lines. However, if there are multiple paragraphs or

3605−other blocks in a list item, the first line of each must be indented.

3606−

3607− + A lazy, lazy, list

3608− item.

3609−

3610− + Another one; this looks

3611− bad but is legal.

3612−

3613− Second paragraph of second

3614− list item.

3615−

3616−### Ordered lists ###

3617−

3618−Ordered lists work just like bulleted lists, except that the items

3619−begin with enumerators rather than bullets.

3620−

3621−In standard Markdown, enumerators are decimal numbers followed

3622−by a period and a space. The numbers themselves are ignored, so

3623−there is no difference between this list:

3624−

3625− 1. one

3626− 2. two

3627− 3. three

3628−

3629−and this one:

3630−

3631− 5. one

3632− 7. two

3633− 1. three

3634−

3635−#### Extension: `fancy_lists` ####

3636−

3637−Unlike standard Markdown, pandoc allows ordered list items to be marked

3638−with uppercase and lowercase letters and roman numerals, in addition to

3639−Arabic numerals. List markers may be enclosed in parentheses or followed by a

3640−single right-parentheses or period. They must be separated from the

3641−text that follows by at least one space, and, if the list marker is a

3642−capital letter with a period, by at least two spaces.[^2]

3643−

3644−[^2]: The point of this rule is to ensure that normal paragraphs

3645− starting with people's initials, like

3646−

3647− B. Russell was an English philosopher.

3648−

3649− do not get treated as list items.

3650−

3651− This rule will not prevent

3652−

3653− (C) 2007 Joe Smith

3654−

3655− from being interpreted as a list item. In this case, a backslash

3656− escape can be used:

3657−

3658− (C\) 2007 Joe Smith

3659−

3660−The `fancy_lists` extension also allows '`#`' to be used as an

3661−ordered list marker in place of a numeral:

3662−

3663− #. one

3664− #. two

3665−

3666−#### Extension: `startnum` ####

3667−

3668−Pandoc also pays attention to the type of list marker used, and to the

3669−starting number, and both of these are preserved where possible in the

3670−output format. Thus, the following yields a list with numbers followed

3671−by a single parenthesis, starting with 9, and a sublist with lowercase

3672−roman numerals:

3673−

3674− 9) Ninth

3675− 10) Tenth

3676− 11) Eleventh

3677− i. subone

3678− ii. subtwo

3679− iii. subthree

3680−

3681−Pandoc will start a new list each time a different type of list

3682−marker is used. So, the following will create three lists:

3683−

3684− (2) Two

3685− (5) Three

3686− 1. Four

3687− * Five

3688−

3689−If default list markers are desired, use `#.`:

3690−

3691− #. one

3692− #. two

3693− #. three

3694−

3695−#### Extension: `task_lists` ####

3696−

3697−Pandoc supports task lists, using the syntax of GitHub-Flavored Markdown.

3698−

3699− - [ ] an unchecked task list item

3700− - [x] checked item

3701−

3702−### Definition lists ###

3703−

3704−#### Extension: `definition_lists` ####

3705−

3706−Pandoc supports definition lists, using the syntax of

3707−[PHP Markdown Extra] with some extensions.[^3]

3708−

3709− Term 1

3710−

3711− : Definition 1

3712−

3713− Term 2 with *inline markup*

3714−

3715− : Definition 2

3716−

3717− { some code, part of Definition 2 }

3718−

3719− Third paragraph of definition 2.

3720−

3721−Each term must fit on one line, which may optionally be followed by

3722−a blank line, and must be followed by one or more definitions.

3723−A definition begins with a colon or tilde, which may be indented one

3724−or two spaces.

3725−

3726−A term may have multiple definitions, and each definition may

3727−consist of one or more block elements (paragraph, code block,

3728−list, etc.), each indented four spaces or one tab stop. The

3729−body of the definition (including the first line, aside from the

3730−colon or tilde) should be indented four spaces. However, as with

3731−other Markdown lists, you can "lazily" omit indentation except

3732−at the beginning of a paragraph or other block element:

3733−

3734− Term 1

3735−

3736− : Definition

3737− with lazy continuation.

3738−

3739− Second paragraph of the definition.

3740−

3741−If you leave space before the definition (as in the example above),

3742−the text of the definition will be treated as a paragraph. In some

3743−output formats, this will mean greater spacing between term/definition

3744−pairs. For a more compact definition list, omit the space before the

3745−definition:

3746−

3747− Term 1

3748− ~ Definition 1

3749−

3750− Term 2

3751− ~ Definition 2a

3752− ~ Definition 2b

3753−

3754−Note that space between items in a definition list is required.

3755−(A variant that loosens this requirement, but disallows "lazy"

3756−hard wrapping, can be activated with `compact_definition_lists`: see

3757−[Non-default extensions], below.)

3758−

3759−[^3]: I have been influenced by the suggestions of [David

3760− Wheeler](https://justatheory.com/2009/02/modest-markdown-proposal/).

3761−

3762−### Numbered example lists ###

3763−

3764−#### Extension: `example_lists` ####

3765−

3766−The special list marker `@` can be used for sequentially numbered

3767−examples. The first list item with a `@` marker will be numbered '1',

3768−the next '2', and so on, throughout the document. The numbered examples

3769−need not occur in a single list; each new list using `@` will take up

3770−where the last stopped. So, for example:

3771−

3772− (@) My first example will be numbered (1).

3773− (@) My second example will be numbered (2).

3774−

3775− Explanation of examples.

3776−

3777− (@) My third example will be numbered (3).

3778−

3779−Numbered examples can be labeled and referred to elsewhere in the

3780−document:

3781−

3782− (@good) This is a good example.

3783−

3784− As (@good) illustrates, ...

3785−

3786−The label can be any string of alphanumeric characters, underscores,

3787−or hyphens.

3788−

3789−Note: continuation paragraphs in example lists must always

3790−be indented four spaces, regardless of the length of the

3791−list marker. That is, example lists always behave as if the

3792−`four_space_rule` extension is set. This is because example

3793−labels tend to be long, and indenting content to the

3794−first non-space character after the label would be awkward.

3795−

3796−

3797−### Ending a list ###

3798−

3799−What if you want to put an indented code block after a list?

3800−

3801− - item one

3802− - item two

3803−

3804− { my code block }

3805−

3806−Trouble! Here pandoc (like other Markdown implementations) will treat

3807−`{ my code block }` as the second paragraph of item two, and not as

3808−a code block.

3809−

3810−To "cut off" the list after item two, you can insert some non-indented

3811−content, like an HTML comment, which won't produce visible output in

3812−any format:

3813−

3814− - item one

3815− - item two

3816−

3817− <!-- end of list -->

3818−

3819− { my code block }

3820−

3821−You can use the same trick if you want two consecutive lists instead

3822−of one big list:

3823−

3824− 1. one

3825− 2. two

3826− 3. three

3827−

3828− <!-- -->

3829−

3830− 1. uno

3831− 2. dos

3832− 3. tres

3833−

3834−## Horizontal rules

3835−

3836−A line containing a row of three or more `*`, `-`, or `_` characters

3837−(optionally separated by spaces) produces a horizontal rule:

3838−

3839− * * * *

3840−

3841− ---------------

3842−

3843−

3844−## Tables

3845−

3846−Four kinds of tables may be used. The first three kinds presuppose the use of

3847−a fixed-width font, such as Courier. The fourth kind can be used with

3848−proportionally spaced fonts, as it does not require lining up columns.

3849−

3850−#### Extension: `table_captions` ####

3851−

3852−A caption may optionally be provided with all 4 kinds of tables (as

3853−illustrated in the examples below). A caption is a paragraph beginning

3854−with the string `Table:` (or just `:`), which will be stripped off.

3855−It may appear either before or after the table.

3856−

3857−#### Extension: `simple_tables` ####

3858−

3859−Simple tables look like this:

3860−

3861− Right Left Center Default

3862− ------- ------ ---------- -------

3863− 12 12 12 12

3864− 123 123 123 123

3865− 1 1 1 1

3866−

3867− Table: Demonstration of simple table syntax.

3868−

3869−The header and table rows must each fit on one line. Column

3870−alignments are determined by the position of the header text relative

3871−to the dashed line below it:[^4]

3872−

3873− - If the dashed line is flush with the header text on the right side

3874− but extends beyond it on the left, the column is right-aligned.

3875− - If the dashed line is flush with the header text on the left side

3876− but extends beyond it on the right, the column is left-aligned.

3877− - If the dashed line extends beyond the header text on both sides,

3878− the column is centered.

3879− - If the dashed line is flush with the header text on both sides,

3880− the default alignment is used (in most cases, this will be left).

3881−

3882−[^4]: This scheme is due to Michel Fortin, who proposed it on the

3883− [Markdown discussion list](http://six.pairlist.net/pipermail/markdown-discuss/2005-March/001097.html).

3884−

3885−The table must end with a blank line, or a line of dashes followed by

3886−a blank line.

3887−

3888−The column header row may be omitted, provided a dashed line is used

3889−to end the table. For example:

3890−

3891− ------- ------ ---------- -------

3892− 12 12 12 12

3893− 123 123 123 123

3894− 1 1 1 1

3895− ------- ------ ---------- -------

3896−

3897−When the header row is omitted, column alignments are determined on the basis

3898−of the first line of the table body. So, in the tables above, the columns

3899−would be right, left, center, and right aligned, respectively.

3900−

3901−#### Extension: `multiline_tables` ####

3902−

3903−Multiline tables allow header and table rows to span multiple lines

3904−of text (but cells that span multiple columns or rows of the table are

3905−not supported). Here is an example:

3906−

3907− -------------------------------------------------------------

3908− Centered Default Right Left

3909− Header Aligned Aligned Aligned

3910− ----------- ------- --------------- -------------------------

3911− First row 12.0 Example of a row that

3912− spans multiple lines.

3913−

3914− Second row 5.0 Here's another one. Note

3915− the blank line between

3916− rows.

3917− -------------------------------------------------------------

3918−

3919− Table: Here's the caption. It, too, may span

3920− multiple lines.

3921−

3922−These work like simple tables, but with the following differences:

3923−

3924− - They must begin with a row of dashes, before the header text

3925− (unless the header row is omitted).

3926− - They must end with a row of dashes, then a blank line.

3927− - The rows must be separated by blank lines.

3928−

3929−In multiline tables, the table parser pays attention to the widths of

3930−the columns, and the writers try to reproduce these relative widths in

3931−the output. So, if you find that one of the columns is too narrow in the

3932−output, try widening it in the Markdown source.

3933−

3934−The header may be omitted in multiline tables as well as simple tables:

3935−

3936− ----------- ------- --------------- -------------------------

3937− First row 12.0 Example of a row that

3938− spans multiple lines.

3939−

3940− Second row 5.0 Here's another one. Note

3941− the blank line between

3942− rows.

3943− ----------- ------- --------------- -------------------------

3944−

3945− : Here's a multiline table without a header.

3946−

3947−It is possible for a multiline table to have just one row, but the row

3948−should be followed by a blank line (and then the row of dashes that ends

3949−the table), or the table may be interpreted as a simple table.

3950−

3951−#### Extension: `grid_tables` ####

3952−

3953−Grid tables look like this:

3954−

3955− : Sample grid table.

3956−

3957− +---------------+---------------+--------------------+

3958− | Fruit | Price | Advantages |

3959− +===============+===============+====================+

3960− | Bananas | $1.34 | - built-in wrapper |

3961− | | | - bright color |

3962− +---------------+---------------+--------------------+

3963− | Oranges | $2.10 | - cures scurvy |

3964− | | | - tasty |

3965− +---------------+---------------+--------------------+

3966−

3967−The row of `=`s separates the header from the table body, and can be

3968−omitted for a headerless table. The cells of grid tables may contain

3969−arbitrary block elements (multiple paragraphs, code blocks, lists,

3970−etc.). Cells that span multiple columns or rows are not

3971−supported. Grid tables can be created easily using Emacs' table-mode

3972−(`M-x table-insert`).

3973−

3974−Alignments can be specified as with pipe tables, by putting

3975−colons at the boundaries of the separator line after the

3976−header:

3977−

3978− +---------------+---------------+--------------------+

3979− | Right | Left | Centered |

3980− +==============:+:==============+:==================:+

3981− | Bananas | $1.34 | built-in wrapper |

3982− +---------------+---------------+--------------------+

3983−

3984−For headerless tables, the colons go on the top line instead:

3985−

3986− +--------------:+:--------------+:------------------:+

3987− | Right | Left | Centered |

3988− +---------------+---------------+--------------------+

3989−

3990−##### Grid Table Limitations #####

3991−

3992−Pandoc does not support grid tables with row spans or column spans.

3993−This means that neither variable numbers of columns across rows nor

3994−variable numbers of rows across columns are supported by Pandoc.

3995−All grid tables must have the same number of columns in each row,

3996−and the same number of rows in each column. For example, the

3997−Docutils [sample grid tables] will not render as expected with

3998−Pandoc.

3999−

4000−[sample grid tables]: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#grid-tables

4001−

4002−

4003−#### Extension: `pipe_tables` ####

4004−

4005−Pipe tables look like this:

4006−

4007− | Right | Left | Default | Center |

4008− |------:|:-----|---------|:------:|

4009− | 12 | 12 | 12 | 12 |

4010− | 123 | 123 | 123 | 123 |

4011− | 1 | 1 | 1 | 1 |

4012−

4013− : Demonstration of pipe table syntax.

4014−

4015−The syntax is identical to [PHP Markdown Extra tables]. The beginning and

4016−ending pipe characters are optional, but pipes are required between all

4017−columns. The colons indicate column alignment as shown. The header

4018−cannot be omitted. To simulate a headerless table, include a header

4019−with blank cells.

4020−

4021−Since the pipes indicate column boundaries, columns need not be vertically

4022−aligned, as they are in the above example. So, this is a perfectly

4023−legal (though ugly) pipe table:

4024−

4025− fruit| price

4026− -----|-----:

4027− apple|2.05

4028− pear|1.37

4029− orange|3.09

4030−

4031−The cells of pipe tables cannot contain block elements like paragraphs

4032−and lists, and cannot span multiple lines. If a pipe table contains a

4033−row whose Markdown content is wider than the column width (see

4034−`--columns`), then the table will take up the full text width and

4035−the cell contents will wrap, with the relative cell widths determined

4036−by the number of dashes in the line separating the table header from

4037−the table body. (For example `---|-` would make the first column 3/4

4038−and the second column 1/4 of the full text width.)

4039−On the other hand, if no lines are wider than column width, then

4040−cell contents will not be wrapped, and the cells will be sized

4041−to their contents.

4042−

4043−Note: pandoc also recognizes pipe tables of the following

4044−form, as can be produced by Emacs' orgtbl-mode:

4045−

4046− | One | Two |

4047− |-----+-------|

4048− | my | table |

4049− | is | nice |

4050−

4051−The difference is that `+` is used instead of `|`. Other orgtbl features

4052−are not supported. In particular, to get non-default column alignment,

4053−you'll need to add colons as above.

4054−

4055−[PHP Markdown Extra tables]: https://michelf.ca/projects/php-markdown/extra/#table

4056−

4057−## Metadata blocks

4058−

4059−#### Extension: `pandoc_title_block` ####

4060−

4061−If the file begins with a title block

4062−

4063− % title

4064− % author(s) (separated by semicolons)

4065− % date

4066−

4067−it will be parsed as bibliographic information, not regular text. (It

4068−will be used, for example, in the title of standalone LaTeX or HTML

4069−output.) The block may contain just a title, a title and an author,

4070−or all three elements. If you want to include an author but no

4071−title, or a title and a date but no author, you need a blank line:

4072−

4073−```

4074−%

4075−% Author

4076−```

4077−

4078−```

4079−% My title

4080−%

4081−% June 15, 2006

4082−```

4083−

4084−The title may occupy multiple lines, but continuation lines must

4085−begin with leading space, thus:

4086−

4087−```

4088−% My title

4089− on multiple lines

4090−```

4091−

4092−If a document has multiple authors, the authors may be put on

4093−separate lines with leading space, or separated by semicolons, or

4094−both. So, all of the following are equivalent:

4095−

4096−```

4097−% Author One

4098− Author Two

4099−```

4100−

4101−```

4102−% Author One; Author Two

4103−```

4104−

4105−```

4106−% Author One;

4107− Author Two

4108−```

4109−

4110−The date must fit on one line.

4111−

4112−All three metadata fields may contain standard inline formatting

4113−(italics, links, footnotes, etc.).

4114−

4115−Title blocks will always be parsed, but they will affect the output only

4116−when the `--standalone` (`-s`) option is chosen. In HTML output, titles

4117−will appear twice: once in the document head -- this is the title that

4118−will appear at the top of the window in a browser -- and once at the

4119−beginning of the document body. The title in the document head can have

4120−an optional prefix attached (`--title-prefix` or `-T` option). The title

4121−in the body appears as an H1 element with class "title", so it can be

4122−suppressed or reformatted with CSS. If a title prefix is specified with

4123−`-T` and no title block appears in the document, the title prefix will

4124−be used by itself as the HTML title.

4125−

4126−The man page writer extracts a title, man page section number, and

4127−other header and footer information from the title line. The title

4128−is assumed to be the first word on the title line, which may optionally

4129−end with a (single-digit) section number in parentheses. (There should

4130−be no space between the title and the parentheses.) Anything after

4131−this is assumed to be additional footer and header text. A single pipe

4132−character (`|`) should be used to separate the footer text from the header

4133−text. Thus,

4134−

4135− % PANDOC(1)

4136−

4137−will yield a man page with the title `PANDOC` and section 1.

4138−

4139− % PANDOC(1) Pandoc User Manuals

4140−

4141−will also have "Pandoc User Manuals" in the footer.

4142−

4143− % PANDOC(1) Pandoc User Manuals | Version 4.0

4144−

4145−will also have "Version 4.0" in the header.

4146−

4147−#### Extension: `yaml_metadata_block` ####

4148−

4149−A [YAML] metadata block is a valid YAML object, delimited by a line of three

4150−hyphens (`---`) at the top and a line of three hyphens (`---`) or three dots

4151−(`...`) at the bottom. A YAML metadata block may occur anywhere in the

4152−document, but if it is not at the beginning, it must be preceded by a blank

4153−line. (Note that, because of the way pandoc concatenates input files when

4154−several are provided, you may also keep the metadata in a separate YAML file

4155−and pass it to pandoc as an argument, along with your Markdown files:

4156−

4157− pandoc chap1.md chap2.md chap3.md metadata.yaml -s -o book.html

4158−

4159−Just be sure that the YAML file begins with `---` and ends with `---` or

4160−`...`.) Alternatively, you can use the `--metadata-file` option. Using

4161−that approach however, you cannot reference content (like footnotes)

4162−from the main markdown input document.

4163−

4164−Metadata will be taken from the fields of the YAML object and added to any

4165−existing document metadata. Metadata can contain lists and objects (nested

4166−arbitrarily), but all string scalars will be interpreted as Markdown. Fields

4167−with names ending in an underscore will be ignored by pandoc. (They may be

4168−given a role by external processors.) Field names must not be

4169−interpretable as YAML numbers or boolean values (so, for

4170−example, `yes`, `True`, and `15` cannot be used as field names).

4171−

4172−A document may contain multiple metadata blocks. If two

4173−metadata blocks attempt to set the same field, the value from

4174−the second block will be taken.

4175−

4176−When pandoc is used with `-t markdown` to create a Markdown document,

4177−a YAML metadata block will be produced only if the `-s/--standalone`

4178−option is used. All of the metadata will appear in a single block

4179−at the beginning of the document.

4180−

4181−Note that [YAML] escaping rules must be followed. Thus, for example,

4182−if a title contains a colon, it must be quoted, and if it contains a

4183−backslash escape, then it must be ensured that it is not treated as a

4184−[YAML escape sequence]. The pipe character (`|`) can be used to begin

4185−an indented block that will be interpreted literally, without need for

4186−escaping. This form is necessary when the field contains blank lines

4187−or block-level formatting:

4188−

4189− ---

4190− title: 'This is the title: it contains a colon'

4191− author:

4192− - Author One

4193− - Author Two

4194− keywords: [nothing, nothingness]

4195− abstract: |

4196− This is the abstract.

4197−

4198− It consists of two paragraphs.

4199− ...

4200−

4201−The literal block after the `|` must be indented relative to the

4202−line containing the `|`. If it is not, the YAML will be invalid

4203−and pandoc will not interpret it as metadata. For an overview

4204−of the complex rules governing YAML, see the [Wikipedia entry on

4205−YAML syntax].

4206−

4207−Template variables will be set automatically from the metadata. Thus, for

4208−example, in writing HTML, the variable `abstract` will be set to the HTML

4209−equivalent of the Markdown in the `abstract` field:

4210−

4211− <p>This is the abstract.</p>

4212− <p>It consists of two paragraphs.</p>

4213−

4214−Variables can contain arbitrary YAML structures, but the template must match

4215−this structure. The `author` variable in the default templates expects a

4216−simple list or string, but can be changed to support more complicated

4217−structures. The following combination, for example, would add an affiliation

4218−to the author if one is given:

4219−

4220− ---

4221− title: The document title

4222− author:

4223− - name: Author One

4224− affiliation: University of Somewhere

4225− - name: Author Two

4226− affiliation: University of Nowhere

4227− ...

4228−

4229−To use the structured authors in the example above, you would need a custom

4230−template:

4231−

4232− $for(author)$

4233− $if(author.name)$

4234− $author.name$$if(author.affiliation)$ ($author.affiliation$)$endif$

4235− $else$

4236− $author$

4237− $endif$

4238− $endfor$

4239−

4240−Raw content to include in the document's header may be specified

4241−using `header-includes`; however, it is important to mark up

4242−this content as raw code for a particular output format, using

4243−the [`raw_attribute` extension](#extension-raw_attribute)), or it

4244−will be interpreted as markdown. For example:

4245−

4246− header-includes:

4247− - |

4248− ```{=latex}

4249− \let\oldsection\section

4250− \renewcommand{\section}[1]{\clearpage\oldsection{#1}}

4251− ```

4252−

4253−Note: the `yaml_metadata_block` extension works with

4254−`commonmark` as well as `markdown` (and it is enabled by default

4255−in `gfm` and `commonmark_x`). However, in these formats the

4256−following restrictions apply:

4257−

4258−- The YAML metadata block must occur at the beginning of the

4259− document (and there can be only one). If multiple files are

4260− given as arguments to pandoc, only the first can be a YAML

4261− metadata block.

4262−

4263−- The leaf nodes of the YAML structure are parsed in isolation from

4264− each other and from the rest of the document. So, for

4265− example, you can't use a reference link in these contexts

4266− if the link definition is somewhere else in the document.

4267−

4268−[YAML escape sequence]: https://yaml.org/spec/1.2/spec.html#id2776092

4269−[Wikipedia entry on YAML syntax]: https://en.m.wikipedia.org/wiki/YAML#Syntax

4270−

4271−## Backslash escapes

4272−

4273−#### Extension: `all_symbols_escapable` ####

4274−

4275−Except inside a code block or inline code, any punctuation or space

4276−character preceded by a backslash will be treated literally, even if it

4277−would normally indicate formatting. Thus, for example, if one writes

4278−

4279− *\*hello\**

4280−

4281−one will get

2667+A caption may optionally be provided with all 4 kinds of tables (as

2668+illustrated in the examples below). A caption is a paragraph beginning

2669+with the string `Table:` (or just `:`), which will be stripped off.

2670+It may appear either before or after the table.

42822671

4283− <em>*hello*</em>

2672+#### Extension: `simple_tables` ####

42842673

4285−instead of

2674+Simple tables look like this:

42862675

4287− <strong>hello</strong>

2676+ Right Left Center Default

2677+ ------- ------ ---------- -------

2678+ 12 12 12 12

2679+ 123 123 123 123

2680+ 1 1 1 1

42882681

4289−This rule is easier to remember than standard Markdown's rule,

4290−which allows only the following characters to be backslash-escaped:

2682+ Table: Demonstration of simple table syntax.

42912683

4292− \`*_{}[]()>#+-.!

2684+The headers and table rows must each fit on one line. Column

2685+alignments are determined by the position of the header text relative

2686+to the dashed line below it:[^4]

42932687

4294−(However, if the `markdown_strict` format is used, the standard Markdown rule

4295−will be used.)

2688+ - If the dashed line is flush with the header text on the right side

2689+ but extends beyond it on the left, the column is right-aligned.

2690+ - If the dashed line is flush with the header text on the left side

2691+ but extends beyond it on the right, the column is left-aligned.

2692+ - If the dashed line extends beyond the header text on both sides,

2693+ the column is centered.

2694+ - If the dashed line is flush with the header text on both sides,

2695+ the default alignment is used (in most cases, this will be left).

42962696

4297−A backslash-escaped space is parsed as a nonbreaking space. In TeX output,

4298−it will appear as `~`. In HTML and XML output, it will appear as a

4299−literal unicode nonbreaking space character (note that it will thus

4300−actually look "invisible" in the generated HTML source; you can still

4301−use the `--ascii` command-line option to make it appear as an explicit

4302−entity).

2697+[^4]: This scheme is due to Michel Fortin, who proposed it on the

2698+ [Markdown discussion list](http://six.pairlist.net/pipermail/markdown-discuss/2005-March/001097.html).

43032699

4304−A backslash-escaped newline (i.e. a backslash occurring at the end of

4305−a line) is parsed as a hard line break. It will appear in TeX output as

4306−`\\` and in HTML as `<br />`. This is a nice alternative to

4307−Markdown's "invisible" way of indicating hard line breaks using

4308−two trailing spaces on a line.

2700+The table must end with a blank line, or a line of dashes followed by

2701+a blank line.

43092702

4310−Backslash escapes do not work in verbatim contexts.

2703+The column headers may be omitted, provided a dashed line is used

2704+to end the table. For example:

43112705

4312−## Inline formatting

2706+ ------- ------ ---------- -------

2707+ 12 12 12 12

2708+ 123 123 123 123

2709+ 1 1 1 1

2710+ ------- ------ ---------- -------

43132711

4314−### Emphasis ###

2712+When headers are omitted, column alignments are determined on the basis

2713+of the first line of the table body. So, in the tables above, the columns

2714+would be right, left, center, and right aligned, respectively.

43152715

4316−To *emphasize* some text, surround it with `*`s or `_`, like this:

2716+#### Extension: `multiline_tables` ####

43172717

4318− This text is _emphasized with underscores_, and this

4319− is *emphasized with asterisks*.

2718+Multiline tables allow headers and table rows to span multiple lines

2719+of text (but cells that span multiple columns or rows of the table are

2720+not supported). Here is an example:

43202721

4321−Double `*` or `_` produces **strong emphasis**:

2722+ -------------------------------------------------------------

2723+ Centered Default Right Left

2724+ Header Aligned Aligned Aligned

2725+ ----------- ------- --------------- -------------------------

2726+ First row 12.0 Example of a row that

2727+ spans multiple lines.

43222728

4323− This is **strong emphasis** and __with underscores__.

2729+ Second row 5.0 Here's another one. Note

2730+ the blank line between

2731+ rows.

2732+ -------------------------------------------------------------

43242733

4325−A `*` or `_` character surrounded by spaces, or backslash-escaped,

4326−will not trigger emphasis:

2734+ Table: Here's the caption. It, too, may span

2735+ multiple lines.

43272736

4328− This is * not emphasized *, and \*neither is this\*.

2737+These work like simple tables, but with the following differences:

43292738

4330−#### Extension: `intraword_underscores` ####

2739+ - They must begin with a row of dashes, before the header text

2740+ (unless the headers are omitted).

2741+ - They must end with a row of dashes, then a blank line.

2742+ - The rows must be separated by blank lines.

43312743

4332−Because `_` is sometimes used inside words and identifiers,

4333−pandoc does not interpret a `_` surrounded by alphanumeric

4334−characters as an emphasis marker. If you want to emphasize

4335−just part of a word, use `*`:

2744+In multiline tables, the table parser pays attention to the widths of

2745+the columns, and the writers try to reproduce these relative widths in

2746+the output. So, if you find that one of the columns is too narrow in the

2747+output, try widening it in the Markdown source.

43362748

4337− feas*ible*, not feas*able*.

2749+Headers may be omitted in multiline tables as well as simple tables:

43382750

2751+ ----------- ------- --------------- -------------------------

2752+ First row 12.0 Example of a row that

2753+ spans multiple lines.

43392754

4340−### Strikeout ###

2755+ Second row 5.0 Here's another one. Note

2756+ the blank line between

2757+ rows.

2758+ ----------- ------- --------------- -------------------------

43412759

4342−#### Extension: `strikeout` ####

2760+ : Here's a multiline table without headers.

43432761

4344−To strikeout a section of text with a horizontal line, begin and end it

4345−with `~~`. Thus, for example,

2762+It is possible for a multiline table to have just one row, but the row

2763+should be followed by a blank line (and then the row of dashes that ends

2764+the table), or the table may be interpreted as a simple table.

43462765

4347− This ~~is deleted text.~~

2766+#### Extension: `grid_tables` ####

43482767

2768+Grid tables look like this:

43492769

4350−### Superscripts and subscripts ###

2770+ : Sample grid table.

43512771

4352−#### Extension: `superscript`, `subscript` ####

2772+ +---------------+---------------+--------------------+

2773+ | Fruit | Price | Advantages |

2774+ +===============+===============+====================+

2775+ | Bananas | $1.34 | - built-in wrapper |

2776+ | | | - bright color |

2777+ +---------------+---------------+--------------------+

2778+ | Oranges | $2.10 | - cures scurvy |

2779+ | | | - tasty |

2780+ +---------------+---------------+--------------------+

43532781

4354−Superscripts may be written by surrounding the superscripted text by `^`

4355−characters; subscripts may be written by surrounding the subscripted

4356−text by `~` characters. Thus, for example,

2782+The row of `=`s separates the header from the table body, and can be

2783+omitted for a headerless table. The cells of grid tables may contain

2784+arbitrary block elements (multiple paragraphs, code blocks, lists,

2785+etc.). Cells that span multiple columns or rows are not

2786+supported. Grid tables can be created easily using [Emacs table mode].

43572787

4358− H~2~O is a liquid. 2^10^ is 1024.

2788+[Emacs table mode]: http://table.sourceforge.net/

43592789

4360−The text between `^...^` or `~...~` may not contain spaces or

4361−newlines. If the superscripted or subscripted text contains

4362−spaces, these spaces must be escaped with backslashes. (This is

4363−to prevent accidental superscripting and subscripting through

4364−the ordinary use of `~` and `^`, and also bad interactions with

4365−footnotes.) Thus, if you want the letter P with 'a cat' in

4366−subscripts, use `P~a\ cat~`, not `P~a cat~`.

2790+Alignments can be specified as with pipe tables, by putting

2791+colons at the boundaries of the separator line after the

2792+header:

43672793

4368−### Verbatim ###

2794+ +---------------+---------------+--------------------+

2795+ | Right | Left | Centered |

2796+ +==============:+:==============+:==================:+

2797+ | Bananas | $1.34 | built-in wrapper |

2798+ +---------------+---------------+--------------------+

43692799

4370−To make a short span of text verbatim, put it inside backticks:

2800+For headerless tables, the colons go on the top line instead:

43712801

4372− What is the difference between `>>=` and `>>`?

2802+ +--------------:+:--------------+:------------------:+

2803+ | Right | Left | Centered |

2804+ +---------------+---------------+--------------------+

43732805

4374−If the verbatim text includes a backtick, use double backticks:

2806+##### Grid Table Limitations #####

43752807

4376− Here is a literal backtick `` ` ``.

2808+Pandoc does not support grid tables with row spans or column spans.

2809+This means that neither variable numbers of columns across rows nor

2810+variable numbers of rows across columns are supported by Pandoc.

2811+All grid tables must have the same number of columns in each row,

2812+and the same number of rows in each column. For example, the

2813+Docutils [sample grid tables] will not render as expected with

2814+Pandoc.

43772815

4378−(The spaces after the opening backticks and before the closing

4379−backticks will be ignored.)

2816+[sample grid tables]: http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#grid-tables

43802817

4381−The general rule is that a verbatim span starts with a string

4382−of consecutive backticks (optionally followed by a space)

4383−and ends with a string of the same number of backticks (optionally

4384−preceded by a space).

43852818

4386−Note that backslash-escapes (and other Markdown constructs) do not

4387−work in verbatim contexts:

2819+#### Extension: `pipe_tables` ####

43882820

4389− This is a backslash followed by an asterisk: `\*`.

2821+Pipe tables look like this:

43902822

4391−#### Extension: `inline_code_attributes` ####

2823+ | Right | Left | Default | Center |

2824+ |------:|:-----|---------|:------:|

2825+ | 12 | 12 | 12 | 12 |

2826+ | 123 | 123 | 123 | 123 |

2827+ | 1 | 1 | 1 | 1 |

43922828

4393−Attributes can be attached to verbatim text, just as with

4394−[fenced code blocks]:

2829+ : Demonstration of pipe table syntax.

43952830

4396− `<$>`{.haskell}

2831+The syntax is identical to [PHP Markdown Extra tables]. The beginning and

2832+ending pipe characters are optional, but pipes are required between all

2833+columns. The colons indicate column alignment as shown. The header

2834+cannot be omitted. To simulate a headerless table, include a header

2835+with blank cells.

43972836

4398−### Small caps ###

2837+Since the pipes indicate column boundaries, columns need not be vertically

2838+aligned, as they are in the above example. So, this is a perfectly

2839+legal (though ugly) pipe table:

43992840

4400−To write small caps, use the `smallcaps` class:

2841+ fruit| price

2842+ -----|-----:

2843+ apple|2.05

2844+ pear|1.37

2845+ orange|3.09

44012846

4402− [Small caps]{.smallcaps}

2847+The cells of pipe tables cannot contain block elements like paragraphs

2848+and lists, and cannot span multiple lines. If a pipe table contains a

2849+row whose printable content is wider than the column width (see

2850+`--columns`), then the cell contents will wrap, with the

2851+relative cell widths determined by the widths of the separator

2852+lines. (In this case, the table will take up the full text

2853+width.) If no lines are wider than column width, then

2854+cell contents will not be wrapped, and the cells will be sized

2855+to their contents.

44032856

4404−Or, without the `bracketed_spans` extension:

2857+Note: pandoc also recognizes pipe tables of the following

2858+form, as can be produced by Emacs' orgtbl-mode:

44052859

4406− <span class="smallcaps">Small caps</span>

2860+ | One | Two |

2861+ |-----+-------|

2862+ | my | table |

2863+ | is | nice |

44072864

4408−For compatibility with other Markdown flavors, CSS is also supported:

2865+The difference is that `+` is used instead of `|`. Other orgtbl features

2866+are not supported. In particular, to get non-default column alignment,

2867+you'll need to add colons as above.

44092868

4410− <span style="font-variant:small-caps;">Small caps</span>

2869+[PHP Markdown Extra tables]: https://michelf.ca/projects/php-markdown/extra/#table

44112870

4412−This will work in all output formats that support small caps.

2871+Metadata blocks

2872+---------------

44132873

2874+#### Extension: `pandoc_title_block` ####

44142875

4415−## Math

2876+If the file begins with a title block

44162877

4417−#### Extension: `tex_math_dollars` ####

2878+ % title

2879+ % author(s) (separated by semicolons)

2880+ % date

44182881

4419−Anything between two `$` characters will be treated as TeX math. The

4420−opening `$` must have a non-space character immediately to its right,

4421−while the closing `$` must have a non-space character immediately to its

4422−left, and must not be followed immediately by a digit. Thus,

4423−`$20,000 and $30,000` won't parse as math. If for some reason

4424−you need to enclose text in literal `$` characters, backslash-escape

4425−them and they won't be treated as math delimiters.

2882+it will be parsed as bibliographic information, not regular text. (It

2883+will be used, for example, in the title of standalone LaTeX or HTML

2884+output.) The block may contain just a title, a title and an author,

2885+or all three elements. If you want to include an author but no

2886+title, or a title and a date but no author, you need a blank line:

44262887

4427−For display math, use `$$` delimiters. (In this case, the delimiters

4428−may be separated from the formula by whitespace. However, there can be

4429−no blank lines betwen the opening and closing `$$` delimiters.)

2888+ %

2889+ % Author

44302890

4431−TeX math will be printed in all output formats. How it is rendered

4432−depends on the output format:

2891+ % My title

2892+ %

2893+ % June 15, 2006

44332894

4434−LaTeX

4435− ~ It will appear verbatim surrounded by `\(...\)` (for inline

4436− math) or `\[...\]` (for display math).

2895+The title may occupy multiple lines, but continuation lines must

2896+begin with leading space, thus:

44372897

4438−Markdown, Emacs Org mode, ConTeXt, ZimWiki

4439− ~ It will appear verbatim surrounded by `$...$` (for inline

4440− math) or `$$...$$` (for display math).

2898+ % My title

2899+ on multiple lines

44412900

4442−XWiki

4443− ~ It will appear verbatim surrounded by `{{formula}}..{{/formula}}`.

2901+If a document has multiple authors, the authors may be put on

2902+separate lines with leading space, or separated by semicolons, or

2903+both. So, all of the following are equivalent:

44442904

4445−reStructuredText

4446− ~ It will be rendered using an [interpreted text role `:math:`].

2905+ % Author One

2906+ Author Two

44472907

4448−AsciiDoc

4449− ~ For AsciiDoc output format (`-t asciidoc`) it will appear verbatim

4450− surrounded by `latexmath:[$...$]` (for inline math) or

4451− `[latexmath]++++\[...\]+++` (for display math).

4452− For AsciiDoctor output format (`-t asciidoctor`) the LaTex delimiters

4453− (`$..$` and `\[..\]`) are omitted.

2908+ % Author One; Author Two

44542909

4455−Texinfo

4456− ~ It will be rendered inside a `@math` command.

2910+ % Author One;

2911+ Author Two

44572912

4458−roff man, Jira markup

4459− ~ It will be rendered verbatim without `$`'s.

2913+The date must fit on one line.

44602914

4461−MediaWiki, DokuWiki

4462− ~ It will be rendered inside `<math>` tags.

2915+All three metadata fields may contain standard inline formatting

2916+(italics, links, footnotes, etc.).

44632917

4464−Textile

4465− ~ It will be rendered inside `<span class="math">` tags.

2918+Title blocks will always be parsed, but they will affect the output only

2919+when the `--standalone` (`-s`) option is chosen. In HTML output, titles

2920+will appear twice: once in the document head -- this is the title that

2921+will appear at the top of the window in a browser -- and once at the

2922+beginning of the document body. The title in the document head can have

2923+an optional prefix attached (`--title-prefix` or `-T` option). The title

2924+in the body appears as an H1 element with class "title", so it can be

2925+suppressed or reformatted with CSS. If a title prefix is specified with

2926+`-T` and no title block appears in the document, the title prefix will

2927+be used by itself as the HTML title.

44662928

4467−RTF, OpenDocument

4468− ~ It will be rendered, if possible, using Unicode characters,

4469− and will otherwise appear verbatim.

2929+The man page writer extracts a title, man page section number, and

2930+other header and footer information from the title line. The title

2931+is assumed to be the first word on the title line, which may optionally

2932+end with a (single-digit) section number in parentheses. (There should

2933+be no space between the title and the parentheses.) Anything after

2934+this is assumed to be additional footer and header text. A single pipe

2935+character (`|`) should be used to separate the footer text from the header

2936+text. Thus,

44702937

4471−ODT

4472− ~ It will be rendered, if possible, using MathML.

2938+ % PANDOC(1)

44732939

4474−DocBook

4475− ~ If the `--mathml` flag is used, it will be rendered using MathML

4476− in an `inlineequation` or `informalequation` tag. Otherwise it

4477− will be rendered, if possible, using Unicode characters.

2940+will yield a man page with the title `PANDOC` and section 1.

2941+

2942+ % PANDOC(1) Pandoc User Manuals

44782943

4479−Docx

4480− ~ It will be rendered using OMML math markup.

2944+will also have "Pandoc User Manuals" in the footer.

44812945

4482−FictionBook2

4483− ~ If the `--webtex` option is used, formulas are rendered as images

4484− using CodeCogs or other compatible web service, downloaded

4485− and embedded in the e-book. Otherwise, they will appear verbatim.

2946+ % PANDOC(1) Pandoc User Manuals | Version 4.0

44862947

4487−HTML, Slidy, DZSlides, S5, EPUB

4488− ~ The way math is rendered in HTML will depend on the

4489− command-line options selected. Therefore see [Math rendering in HTML]

4490− above.

2948+will also have "Version 4.0" in the header.

44912949

4492−[interpreted text role `:math:`]: https://docutils.sourceforge.io/docs/ref/rst/roles.html#math

2950+#### Extension: `yaml_metadata_block` ####

44932951

4494−## Raw HTML

2952+A YAML metadata block is a valid YAML object, delimited by a line of three

2953+hyphens (`---`) at the top and a line of three hyphens (`---`) or three dots

2954+(`...`) at the bottom. A YAML metadata block may occur anywhere in the

2955+document, but if it is not at the beginning, it must be preceded by a blank

2956+line. (Note that, because of the way pandoc concatenates input files when

2957+several are provided, you may also keep the metadata in a separate YAML file

2958+and pass it to pandoc as an argument, along with your Markdown files:

44952959

4496−#### Extension: `raw_html` ####

2960+ pandoc chap1.md chap2.md chap3.md metadata.yaml -s -o book.html

44972961

4498−Markdown allows you to insert raw HTML (or DocBook) anywhere in a document

4499−(except verbatim contexts, where `<`, `>`, and `&` are interpreted

4500−literally). (Technically this is not an extension, since standard

4501−Markdown allows it, but it has been made an extension so that it can

4502−be disabled if desired.)

2962+Just be sure that the YAML file begins with `---` and ends with `---` or

2963+`...`.)

45032964

4504−The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous,

4505−DZSlides, EPUB, Markdown, CommonMark, Emacs Org mode, and Textile

4506−output, and suppressed in other formats.

2965+Metadata will be taken from the fields of the YAML object and added to any

2966+existing document metadata. Metadata can contain lists and objects (nested

2967+arbitrarily), but all string scalars will be interpreted as Markdown. Fields

2968+with names ending in an underscore will be ignored by pandoc. (They may be

2969+given a role by external processors.)

45072970

4508−For a more explicit way of including raw HTML in a Markdown

4509−document, see the [`raw_attribute` extension][Extension: `raw_attribute`].

2971+A document may contain multiple metadata blocks. The metadata fields will

2972+be combined through a *left-biased union*: if two metadata blocks attempt

2973+to set the same field, the value from the first block will be taken.

45102974

4511−In the CommonMark format, if `raw_html` is enabled, superscripts,

4512−subscripts, strikeouts and small capitals will be represented as HTML.

4513−Otherwise, plain-text fallbacks will be used. Note that even if

4514−`raw_html` is disabled, tables will be rendered with HTML syntax if

4515−they cannot use pipe syntax.

2975+When pandoc is used with `-t markdown` to create a Markdown document,

2976+a YAML metadata block will be produced only if the `-s/--standalone`

2977+option is used. All of the metadata will appear in a single block

2978+at the beginning of the document.

45162979

4517−#### Extension: `markdown_in_html_blocks` ####

2980+Note that YAML escaping rules must be followed. Thus, for example,

2981+if a title contains a colon, it must be quoted. The pipe character

2982+(`|`) can be used to begin an indented block that will be interpreted

2983+literally, without need for escaping. This form is necessary

2984+when the field contains blank lines or block-level formatting:

45182985

4519−Standard Markdown allows you to include HTML "blocks": blocks

4520−of HTML between balanced tags that are separated from the surrounding text

4521−with blank lines, and start and end at the left margin. Within

4522−these blocks, everything is interpreted as HTML, not Markdown;

4523−so (for example), `*` does not signify emphasis.

2986+ ---

2987+ title: 'This is the title: it contains a colon'

2988+ author:

2989+ - Author One

2990+ - Author Two

2991+ tags: [nothing, nothingness]

2992+ abstract: |

2993+ This is the abstract.

45242994

4525−Pandoc behaves this way when the `markdown_strict` format is used; but

4526−by default, pandoc interprets material between HTML block tags as Markdown.

4527−Thus, for example, pandoc will turn

2995+ It consists of two paragraphs.

2996+ ...

45282997

4529− <table>

4530− <tr>

4531− <td>*one*</td>

4532− <td>[a link](https://google.com)</td>

4533− </tr>

4534− </table>

2998+Template variables will be set automatically from the metadata. Thus, for

2999+example, in writing HTML, the variable `abstract` will be set to the HTML

3000+equivalent of the Markdown in the `abstract` field:

45353001

4536−into

3002+ <p>This is the abstract.</p>

3003+ <p>It consists of two paragraphs.</p>

45373004

4538− <table>

4539− <tr>

4540− <td><em>one</em></td>

4541− <td><a href="https://google.com">a link</a></td>

4542− </tr>

4543− </table>

3005+Variables can contain arbitrary YAML structures, but the template must match

3006+this structure. The `author` variable in the default templates expects a

3007+simple list or string, but can be changed to support more complicated

3008+structures. The following combination, for example, would add an affiliation

3009+to the author if one is given:

45443010

4545−whereas `Markdown.pl` will preserve it as is.

3011+ ---

3012+ title: The document title

3013+ author:

3014+ - name: Author One

3015+ affiliation: University of Somewhere

3016+ - name: Author Two

3017+ affiliation: University of Nowhere

3018+ ...

45463019

4547−There is one exception to this rule: text between `<script>`,

4548−`<style>`, and `<textarea>` tags is not interpreted as Markdown.

3020+To use the structured authors in the example above, you would need a custom

3021+template:

45493022

4550−This departure from standard Markdown should make it easier to mix

4551−Markdown with HTML block elements. For example, one can surround

4552−a block of Markdown text with `<div>` tags without preventing it

4553−from being interpreted as Markdown.

3023+ $for(author)$

3024+ $if(author.name)$

3025+ $author.name$$if(author.affiliation)$ ($author.affiliation$)$endif$

3026+ $else$

3027+ $author$

3028+ $endif$

3029+ $endfor$

45543030

4555−#### Extension: `native_divs` ####

45563031

4557−Use native pandoc `Div` blocks for content inside `<div>` tags.

4558−For the most part this should give the same output as

4559−`markdown_in_html_blocks`, but it makes it easier to write pandoc

4560−filters to manipulate groups of blocks.

3032+Backslash escapes

3033+-----------------

45613034

4562−#### Extension: `native_spans` ####

3035+#### Extension: `all_symbols_escapable` ####

45633036

4564−Use native pandoc `Span` blocks for content inside `<span>` tags.

4565−For the most part this should give the same output as `raw_html`,

4566−but it makes it easier to write pandoc filters to manipulate groups

4567−of inlines.

3037+Except inside a code block or inline code, any punctuation or space

3038+character preceded by a backslash will be treated literally, even if it

3039+would normally indicate formatting. Thus, for example, if one writes

45683040

4569−#### Extension: `raw_tex` ####

3041+ *\*hello\**

45703042

4571−In addition to raw HTML, pandoc allows raw LaTeX, TeX, and ConTeXt to be

4572−included in a document. Inline TeX commands will be preserved and passed

4573−unchanged to the LaTeX and ConTeXt writers. Thus, for example, you can use

4574−LaTeX to include BibTeX citations:

3043+one will get

45753044

4576− This result was proved in \cite{jones.1967}.

3045+ <em>*hello*</em>

45773046

4578−Note that in LaTeX environments, like

3047+instead of

45793048

4580− \begin{tabular}{|l|l|}\hline

4581− Age & Frequency \\ \hline

4582− 18--25 & 15 \\

4583− 26--35 & 33 \\

4584− 36--45 & 22 \\ \hline

4585− \end{tabular}

3049+ <strong>hello</strong>

45863050

4587−the material between the begin and end tags will be interpreted as raw

4588−LaTeX, not as Markdown.

3051+This rule is easier to remember than standard Markdown's rule,

3052+which allows only the following characters to be backslash-escaped:

45893053

4590−For a more explicit and flexible way of including raw TeX in a

4591−Markdown document, see the [`raw_attribute`

4592−extension][Extension: `raw_attribute`].

3054+ \`*_{}[]()>#+-.!

45933055

4594−Inline LaTeX is ignored in output formats other than Markdown, LaTeX,

4595−Emacs Org mode, and ConTeXt.

3056+(However, if the `markdown_strict` format is used, the standard Markdown rule

3057+will be used.)

45963058

4597−### Generic raw attribute ###

3059+A backslash-escaped space is parsed as a nonbreaking space. It will

3060+appear in TeX output as `~` and in HTML and XML as `\&#160;` or

3061+`\&nbsp;`.

45983062

4599−#### Extension: `raw_attribute` ####

3063+A backslash-escaped newline (i.e. a backslash occurring at the end of

3064+a line) is parsed as a hard line break. It will appear in TeX output as

3065+`\\` and in HTML as `<br />`. This is a nice alternative to

3066+Markdown's "invisible" way of indicating hard line breaks using

3067+two trailing spaces on a line.

46003068

4601−Inline spans and fenced code blocks with a special

4602−kind of attribute will be parsed as raw content with the

4603−designated format. For example, the following produces a raw

4604−roff `ms` block:

3069+Backslash escapes do not work in verbatim contexts.

46053070

4606− ```{=ms}

4607− .MYMACRO

4608− blah blah

4609− ```

4610−And the following produces a raw `html` inline element:

3071+Inline formatting

3072+-----------------

46113073

4612− This is `<a>html</a>`{=html}

3074+### Emphasis ###

46133075

4614−This can be useful to insert raw xml into `docx` documents, e.g.

4615−a pagebreak:

3076+To *emphasize* some text, surround it with `*`s or `_`, like this:

46163077

4617− ```{=openxml}

4618− <w:p>

4619− <w:r>

4620− <w:br w:type="page"/>

4621− </w:r>

4622− </w:p>

4623− ```

3078+ This text is _emphasized with underscores_, and this

3079+ is *emphasized with asterisks*.

46243080

4625−The format name should match the target format name (see

4626−`-t/--to`, above, for a list, or use `pandoc

4627−--list-output-formats`). Use `openxml` for `docx` output,

4628−`opendocument` for `odt` output, `html5` for `epub3` output,

4629−`html4` for `epub2` output, and `latex`, `beamer`,

4630−`ms`, or `html5` for `pdf` output (depending on what you

4631−use for `--pdf-engine`).

3081+Double `*` or `_` produces **strong emphasis**:

46323082

4633−This extension presupposes that the relevant kind of

4634−inline code or fenced code block is enabled. Thus, for

4635−example, to use a raw attribute with a backtick code block,

4636−`backtick_code_blocks` must be enabled.

3083+ This is **strong emphasis** and __with underscores__.

46373084

4638−The raw attribute cannot be combined with regular attributes.

3085+A `*` or `_` character surrounded by spaces, or backslash-escaped,

3086+will not trigger emphasis:

46393087

4640−## LaTeX macros

3088+ This is * not emphasized *, and \*neither is this\*.

46413089

4642−#### Extension: `latex_macros` ####

3090+#### Extension: `intraword_underscores` ####

46433091

4644−When this extension is enabled, pandoc will parse LaTeX

4645−macro definitions and apply the resulting macros to all LaTeX

4646−math and raw LaTeX. So, for example, the following will work in

4647−all output formats, not just LaTeX:

3092+Because `_` is sometimes used inside words and identifiers,

3093+pandoc does not interpret a `_` surrounded by alphanumeric

3094+characters as an emphasis marker. If you want to emphasize

3095+just part of a word, use `*`:

46483096

4649− \newcommand{\tuple}[1]{\langle #1 \rangle}

3097+ feas*ible*, not feas*able*.

46503098

4651− $\tuple{a, b, c}$

46523099

4653−Note that LaTeX macros will not be applied if they occur

4654−inside a raw span or block marked with the

4655−[`raw_attribute` extension](#extension-raw_attribute).

3100+### Strikeout ###

46563101

4657−When `latex_macros` is disabled, the raw LaTeX and math will

4658−not have macros applied. This is usually a better approach when

4659−you are targeting LaTeX or PDF.

3102+#### Extension: `strikeout` ####

3103+

3104+To strikeout a section of text with a horizontal line, begin and end it

3105+with `~~`. Thus, for example,

46603106

4661−Macro definitions in LaTeX will be passed through as raw LaTeX

4662−only if `latex_macros` is not enabled. Macro definitions in

4663−Markdown source (or other formats allowing `raw_tex`) will

4664−be passed through regardless of whether `latex_macros` is

4665−enabled.

3107+ This ~~is deleted text.~~

46663108

4667−## Links

46683109

4669−Markdown allows links to be specified in several ways.

3110+### Superscripts and subscripts ###

46703111

4671−### Automatic links ###

3112+#### Extension: `superscript`, `subscript` ####

46723113

4673−If you enclose a URL or email address in pointy brackets, it

4674−will become a link:

3114+Superscripts may be written by surrounding the superscripted text by `^`

3115+characters; subscripts may be written by surrounding the subscripted

3116+text by `~` characters. Thus, for example,

46753117

4676− <https://google.com>

4677− <sam@green.eggs.ham>

3118+ H~2~O is a liquid. 2^10^ is 1024.

46783119

4679−### Inline links ###

3120+If the superscripted or subscripted text contains spaces, these spaces

3121+must be escaped with backslashes. (This is to prevent accidental

3122+superscripting and subscripting through the ordinary use of `~` and `^`.)

3123+Thus, if you want the letter P with 'a cat' in subscripts, use

3124+`P~a\ cat~`, not `P~a cat~`.

46803125

4681−An inline link consists of the link text in square brackets,

4682−followed by the URL in parentheses. (Optionally, the URL can

4683−be followed by a link title, in quotes.)

46843126

4685− This is an [inline link](/url), and here's [one with

4686− a title](https://fsf.org "click here for a good time!").

3127+### Verbatim ###

46873128

4688−There can be no space between the bracketed part and the parenthesized part.

4689−The link text can contain formatting (such as emphasis), but the title cannot.

3129+To make a short span of text verbatim, put it inside backticks:

46903130

4691−Email addresses in inline links are not autodetected, so they have to be

4692−prefixed with `mailto`:

3131+ What is the difference between `>>=` and `>>`?

46933132

4694− [Write me!](mailto:sam@green.eggs.ham)

3133+If the verbatim text includes a backtick, use double backticks:

46953134

4696−### Reference links ###

3135+ Here is a literal backtick `` ` ``.

46973136

4698−An *explicit* reference link has two parts, the link itself and the link

4699−definition, which may occur elsewhere in the document (either

4700−before or after the link).

3137+(The spaces after the opening backticks and before the closing

3138+backticks will be ignored.)

47013139

4702−The link consists of link text in square brackets, followed by a label in

4703−square brackets. (There cannot be space between the two unless the

4704−`spaced_reference_links` extension is enabled.) The link definition

4705−consists of the bracketed label, followed by a colon and a space, followed by

4706−the URL, and optionally (after a space) a link title either in quotes or in

4707−parentheses. The label must not be parseable as a citation (assuming

4708−the `citations` extension is enabled): citations take precedence over

4709−link labels.

3140+The general rule is that a verbatim span starts with a string

3141+of consecutive backticks (optionally followed by a space)

3142+and ends with a string of the same number of backticks (optionally

3143+preceded by a space).

47103144

4711−Here are some examples:

3145+Note that backslash-escapes (and other Markdown constructs) do not

3146+work in verbatim contexts:

47123147

4713− [my label 1]: /foo/bar.html "My title, optional"

4714− [my label 2]: /foo

4715− [my label 3]: https://fsf.org (The free software foundation)

4716− [my label 4]: /bar#special 'A title in single quotes'

3148+ This is a backslash followed by an asterisk: `\*`.

47173149

4718−The URL may optionally be surrounded by angle brackets:

3150+#### Extension: `inline_code_attributes` ####

47193151

4720− [my label 5]: <http://foo.bar.baz>

3152+Attributes can be attached to verbatim text, just as with

3153+[fenced code blocks]:

47213154

4722−The title may go on the next line:

3155+ `<$>`{.haskell}

47233156

4724− [my label 3]: https://fsf.org

4725− "The free software foundation"

3157+### Small caps ###

47263158

4727−Note that link labels are not case sensitive. So, this will work:

3159+To write small caps, use the `smallcaps` class:

3160+

3161+ [Small caps]{.smallcaps}

47283162

4729− Here is [my link][FOO]

3163+Or, without the `bracketed_spans` extension:

47303164

4731− [Foo]: /bar/baz

3165+ <span class="smallcaps">Small caps</span>

47323166

4733−In an *implicit* reference link, the second pair of brackets is

4734−empty:

3167+For compatibility with other Markdown flavors, CSS is also supported:

47353168

4736− See [my website][].

3169+ <span style="font-variant:small-caps;">Small caps</span>

47373170

4738− [my website]: http://foo.bar.baz

3171+This will work in all output formats that support small caps.

47393172

4740−Note: In `Markdown.pl` and most other Markdown implementations,

4741−reference link definitions cannot occur in nested constructions

4742−such as list items or block quotes. Pandoc lifts this arbitrary

4743−seeming restriction. So the following is fine in pandoc, though

4744−not in most other implementations:

47453173

4746− > My block [quote].

4747− >

4748− > [quote]: /foo

3174+Math

3175+----

47493176

4750−#### Extension: `shortcut_reference_links` ####

3177+#### Extension: `tex_math_dollars` ####

47513178

4752−In a *shortcut* reference link, the second pair of brackets may

4753−be omitted entirely:

3179+Anything between two `$` characters will be treated as TeX math. The

3180+opening `$` must have a non-space character immediately to its right,

3181+while the closing `$` must have a non-space character immediately to its

3182+left, and must not be followed immediately by a digit. Thus,

3183+`$20,000 and $30,000` won't parse as math. If for some reason

3184+you need to enclose text in literal `$` characters, backslash-escape

3185+them and they won't be treated as math delimiters.

47543186

4755− See [my website].

3187+TeX math will be printed in all output formats. How it is rendered

3188+depends on the output format:

47563189

4757− [my website]: http://foo.bar.baz

3190+Markdown, LaTeX, Emacs Org mode, ConTeXt, ZimWiki

3191+ ~ It will appear verbatim between `$` characters.

47583192

4759−### Internal links ###

3193+reStructuredText

3194+ ~ It will be rendered using an [interpreted text role `:math:`].

47603195

4761−To link to another section of the same document, use the automatically

4762−generated identifier (see [Heading identifiers]). For example:

3196+AsciiDoc

3197+ ~ It will be rendered as `latexmath:[...]`.

47633198

4764− See the [Introduction](#introduction).

3199+Texinfo

3200+ ~ It will be rendered inside a `@math` command.

47653201

4766−or

3202+groff man

3203+ ~ It will be rendered verbatim without `$`'s.

47673204

4768− See the [Introduction].

3205+MediaWiki, DokuWiki

3206+ ~ It will be rendered inside `<math>` tags.

47693207

4770− [Introduction]: #introduction

3208+Textile

3209+ ~ It will be rendered inside `<span class="math">` tags.

47713210

4772−Internal links are currently supported for HTML formats (including

4773−HTML slide shows and EPUB), LaTeX, and ConTeXt.

3211+RTF, OpenDocument

3212+ ~ It will be rendered, if possible, using Unicode characters,

3213+ and will otherwise appear verbatim.

47743214

4775−## Images

3215+ODT

3216+ ~ It will be rendered, if possible, using MathML.

47763217

4777−A link immediately preceded by a `!` will be treated as an image.

4778−The link text will be used as the image's alt text:

3218+DocBook

3219+ ~ If the `--mathml` flag is used, it will be rendered using MathML

3220+ in an `inlineequation` or `informalequation` tag. Otherwise it

3221+ will be rendered, if possible, using Unicode characters.

47793222

4780− 

3223+Docx

3224+ ~ It will be rendered using OMML math markup.

47813225

4782− ![movie reel]

3226+FictionBook2

3227+ ~ If the `--webtex` option is used, formulas are rendered as images

3228+ using CodeCogs or other compatible web service, downloaded

3229+ and embedded in the e-book. Otherwise, they will appear verbatim.

47833230

4784− [movie reel]: movie.gif

3231+HTML, Slidy, DZSlides, S5, EPUB

3232+ ~ The way math is rendered in HTML will depend on the

3233+ command-line options selected. Therefore see [Math rendering in HTML]

3234+ above.

47853235

4786−#### Extension: `implicit_figures` ####

3236+[interpreted text role `:math:`]: http://docutils.sourceforge.net/docs/ref/rst/roles.html#math

47873237

4788−An image with nonempty alt text, occurring by itself in a

4789−paragraph, will be rendered as a figure with a caption. The

4790−image's alt text will be used as the caption.

3238+Raw HTML

3239+--------

47913240

4792− 

3241+#### Extension: `raw_html` ####

47933242

4794−How this is rendered depends on the output format. Some output

4795−formats (e.g. RTF) do not yet support figures. In those

4796−formats, you'll just get an image in a paragraph by itself, with

4797−no caption.

3243+Markdown allows you to insert raw HTML (or DocBook) anywhere in a document

3244+(except verbatim contexts, where `<`, `>`, and `&` are interpreted

3245+literally). (Technically this is not an extension, since standard

3246+Markdown allows it, but it has been made an extension so that it can

3247+be disabled if desired.)

47983248

4799−If you just want a regular inline image, just make sure it is not

4800−the only thing in the paragraph. One way to do this is to insert a

4801−nonbreaking space after the image:

3249+The raw HTML is passed through unchanged in HTML, S5, Slidy, Slideous,

3250+DZSlides, EPUB, Markdown, Emacs Org mode, and Textile output, and suppressed

3251+in other formats.

48023252

4803− \

3253+#### Extension: `markdown_in_html_blocks` ####

48043254

4805−Note that in reveal.js slide shows, an image in a paragraph

4806−by itself that has the `stretch` class will fill the screen,

4807−and the caption and figure tags will be omitted.

3255+Standard Markdown allows you to include HTML "blocks": blocks

3256+of HTML between balanced tags that are separated from the surrounding text

3257+with blank lines, and start and end at the left margin. Within

3258+these blocks, everything is interpreted as HTML, not Markdown;

3259+so (for example), `*` does not signify emphasis.

48083260

4809−#### Extension: `link_attributes` ####

3261+Pandoc behaves this way when the `markdown_strict` format is used; but

3262+by default, pandoc interprets material between HTML block tags as Markdown.

3263+Thus, for example, pandoc will turn

48103264

4811−Attributes can be set on links and images:

3265+ <table>

3266+ <tr>

3267+ <td>*one*</td>

3268+ <td>[a link](http://google.com)</td>

3269+ </tr>

3270+ </table>

48123271

4813− An inline {#id .class width=30 height=20px}

4814− and a reference ![image][ref] with attributes.

3272+into

48153273

4816− [ref]: foo.jpg "optional title" {#id .class key=val key2="val 2"}

3274+ <table>

3275+ <tr>

3276+ <td><em>one</em></td>

3277+ <td><a href="http://google.com">a link</a></td>

3278+ </tr>

3279+ </table>

48173280

4818−(This syntax is compatible with [PHP Markdown Extra] when only `#id`

4819−and `.class` are used.)

3281+whereas `Markdown.pl` will preserve it as is.

48203282

4821−For HTML and EPUB, all known HTML5 attributes except `width` and

4822−`height` (but including `srcset` and `sizes`) are passed through

4823−as is. Unknown attributes are passed through as custom

4824−attributes, with `data-` prepended. The other writers ignore

4825−attributes that are not specifically supported by their output format.

3283+There is one exception to this rule: text between `<script>` and

3284+`<style>` tags is not interpreted as Markdown.

48263285

4827−The `width` and `height` attributes on images are treated specially. When

4828−used without a unit, the unit is assumed to be pixels. However, any of

4829−the following unit identifiers can be used: `px`, `cm`, `mm`, `in`, `inch`

4830−and `%`. There must not be any spaces between the number and the unit.

4831−For example:

3286+This departure from standard Markdown should make it easier to mix

3287+Markdown with HTML block elements. For example, one can surround

3288+a block of Markdown text with `<div>` tags without preventing it

3289+from being interpreted as Markdown.

48323290

4833−```

4834−{ width=50% }

4835−```

3291+#### Extension: `native_divs` ####

48363292

4837−- Dimensions may be converted to a form that is compatible with

4838− the output format (for example, dimensions given in pixels will

4839− be converted to inches when converting HTML to LaTeX). Conversion

4840− between pixels and physical measurements is affected by the

4841− `--dpi` option (by default, 96 dpi is assumed, unless the image

4842− itself contains dpi information).

4843−- The `%` unit is generally relative to some available space.

4844− For example the above example will render to the following.

4845− - HTML: `<img href="file.jpg" style="width: 50%;" />`

4846− - LaTeX: `\includegraphics[width=0.5\textwidth,height=\textheight]{file.jpg}`

4847− (If you're using a custom template, you need to configure `graphicx`

4848− as in the default template.)

4849− - ConTeXt: `\externalfigure[file.jpg][width=0.5\textwidth]`

4850−- Some output formats have a notion of a class

4851− ([ConTeXt](https://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))

4852− or a unique identifier (LaTeX `\caption`), or both (HTML).

4853−- When no `width` or `height` attributes are specified, the fallback

4854− is to look at the image resolution and the dpi metadata embedded in

4855− the image file.

3293+Use native pandoc `Div` blocks for content inside `<div>` tags.

3294+For the most part this should give the same output as

3295+`markdown_in_html_blocks`, but it makes it easier to write pandoc

3296+filters to manipulate groups of blocks.

48563297

4857−## Divs and Spans

3298+#### Extension: `native_spans` ####

48583299

4859−Using the `native_divs` and `native_spans` extensions

4860−(see [above][Extension: `native_divs`]), HTML syntax can

4861−be used as part of markdown to create native `Div` and `Span`

4862−elements in the pandoc AST (as opposed to raw HTML).

4863−However, there is also nicer syntax available:

3300+Use native pandoc `Span` blocks for content inside `<span>` tags.

3301+For the most part this should give the same output as `raw_html`,

3302+but it makes it easier to write pandoc filters to manipulate groups

3303+of inlines.

48643304

48653305#### Extension: `fenced_divs` ####

48663306

@@ -4901,456 +3341,364 @@ fence need not match the number in the opening fence. However,

49013341it can be helpful for visual clarity to use fences of different

49023342lengths to distinguish nested divs from their parents.

49033343

3344+#### Extension: `raw_tex` ####

49043345

4905−#### Extension: `bracketed_spans` ####

4906−

4907−A bracketed sequence of inlines, as one would use to begin

4908−a link, will be treated as a `Span` with attributes if it is

4909−followed immediately by attributes:

4910−

4911− [This is *some text*]{.class key="val"}

4912−

4913−## Footnotes

4914−

4915−#### Extension: `footnotes` ####

4916−

4917−Pandoc's Markdown allows footnotes, using the following syntax:

4918−

4919− Here is a footnote reference,[^1] and another.[^longnote]

3346+In addition to raw HTML, pandoc allows raw LaTeX, TeX, and ConTeXt to be

3347+included in a document. Inline TeX commands will be preserved and passed

3348+unchanged to the LaTeX and ConTeXt writers. Thus, for example, you can use

3349+LaTeX to include BibTeX citations:

49203350

4921− [^1]: Here is the footnote.

3351+ This result was proved in \cite{jones.1967}.

49223352

4923− [^longnote]: Here's one with multiple blocks.

3353+Note that in LaTeX environments, like

49243354

4925− Subsequent paragraphs are indented to show that they

4926− belong to the previous footnote.

3355+ \begin{tabular}{|l|l|}\hline

3356+ Age & Frequency \\ \hline

3357+ 18--25 & 15 \\

3358+ 26--35 & 33 \\

3359+ 36--45 & 22 \\ \hline

3360+ \end{tabular}

49273361

4928− { some.code }

3362+the material between the begin and end tags will be interpreted as raw

3363+LaTeX, not as Markdown.

49293364

4930− The whole paragraph can be indented, or just the first

4931− line. In this way, multi-paragraph footnotes work like

4932− multi-paragraph list items.

3365+Inline LaTeX is ignored in output formats other than Markdown, LaTeX,

3366+Emacs Org mode, and ConTeXt.

49333367

4934− This paragraph won't be part of the note, because it

4935− isn't indented.

3368+### Generic raw attribute ###

49363369

4937−The identifiers in footnote references may not contain spaces, tabs,

4938−or newlines. These identifiers are used only to correlate the

4939−footnote reference with the note itself; in the output, footnotes

4940−will be numbered sequentially.

3370+#### Extension: `raw_attribute` ####

49413371

4942−The footnotes themselves need not be placed at the end of the

4943−document. They may appear anywhere except inside other block elements

4944−(lists, block quotes, tables, etc.). Each footnote should be

4945−separated from surrounding content (including other footnotes)

4946−by blank lines.

3372+Inline spans and fenced code blocks with a special

3373+kind of attribute will be parsed as raw content with the

3374+designated format. For example, the following produces a raw

3375+groff `ms` block:

49473376

4948−#### Extension: `inline_notes` ####

3377+ ```{=ms}

3378+ .MYMACRO

3379+ blah blah

3380+ ```

3381+And the following produces a raw `html` inline element:

49493382

4950−Inline footnotes are also allowed (though, unlike regular notes,

4951−they cannot contain multiple paragraphs). The syntax is as follows:

3383+ This is `<a>html</a>`{=html}

49523384

4953− Here is an inline note.^[Inlines notes are easier to write, since

4954− you don't have to pick an identifier and move down to type the

4955− note.]

3385+The format name should match the target format name (see

3386+`-t/--to`, above, for a list, or use `pandoc

3387+--list-output-formats`).

49563388

4957−Inline and regular footnotes may be mixed freely.

3389+This extension presupposes that the relevant kind of

3390+inline code or fenced code block is enabled. Thus, for

3391+example, to use a raw attribute with a backtick code block,

3392+`backtick_code_blocks` must be enabled.

49583393

4959−## Citation syntax

3394+The raw attribute cannot be combined with regular attributes.

49603395

4961−#### Extension: `citations` ####

3396+LaTeX macros

3397+------------

49623398

4963−To cite a bibliographic item with an identifier foo, use the

4964−syntax `@foo`. Normal citations should be included in square

4965−brackets, with semicolons separating distinct items:

3399+#### Extension: `latex_macros` ####

49663400

4967− Blah blah [@doe99; @smith2000; @smith2004].

3401+For output formats other than LaTeX, pandoc will parse LaTeX

3402+macro definitions and apply the resulting macros to all LaTeX

3403+math and raw LaTeX. So, for example, the following will work in

3404+all output formats, not just LaTeX:

49683405

4969−How this is rendered depends on the citation style. In an

4970−author-date style, it might render as

3406+ \newcommand{\tuple}[1]{\langle #1 \rangle}

49713407

4972− Blah blah (Doe 1999, Smith 2000, 2004).

3408+ $\tuple{a, b, c}$

49733409

4974−In a footnote style, it might render as

3410+In LaTeX output, the macro definitions will not be passed

3411+through as raw LaTeX.

49753412

4976− Blah blah.[^1]

3413+When `latex_macros` is disabled, the macro definitions will

3414+be passed through as raw LaTeX, and the raw LaTeX and math will

3415+not have macros applied. This is usually a better approach when

3416+you are targeting LaTeX or PDF.

49773417

4978− [^1]: John Doe, "Frogs," *Journal of Amphibians* 44 (1999);

4979− Susan Smith, "Flies," *Journal of Insects* (2000);

4980− Susan Smith, "Bees," *Journal of Insects* (2004).

3418+Links

3419+-----

49813420

4982−See the [CSL user documentation] for more information about CSL

4983−styles and how they affect rendering.

3421+Markdown allows links to be specified in several ways.

49843422

4985−Unless a citation key start with a letter, digit, or `_`,

4986−and contains only alphanumerics and internal punctuation

4987−characters (`:.#$%&-+?<>~/`), it must be surrounded

4988−by curly braces, which are not considered part of the key.

4989−In `@Foo_bar.baz.`, the key is `Foo_bar.baz`. The final

4990−period is not *internal* punctuation, so it is not included in

4991−the key. In `@{Foo_bar.baz.}`, the key is `Foo_bar.baz.`, including

4992−the final period. The curly braces are recommended if you use URLs as

4993−keys: `[@{https://example.com/bib?name=foobar&date=2000}, p. 33]`.

3423+### Automatic links ###

49943424

4995−Citation items may optionally include a prefix, a locator, and

4996−a suffix. In

3425+If you enclose a URL or email address in pointy brackets, it

3426+will become a link:

49973427

4998− Blah blah [see @doe99, pp. 33-35 and *passim*; @smith04, chap. 1].

3428+ <http://google.com>

3429+ <sam@green.eggs.ham>

49993430

5000−The first item (`doe99`) has prefix `see `, locator `pp. 33-35`,

5001−and suffix `and *passim*`. The second item (`smith04`) has

5002−locator `chap. 1` and no prefix or suffix.

3431+### Inline links ###

50033432

5004−Pandoc uses some heuristics to separate the locator from the

5005−rest of the subject. It is sensitive to the locator terms

5006−defined in the [CSL locale files]. Either abbreviated or

5007−unabbreviated forms are accepted. In the `en-US` locale, locator

5008−terms can be written in either singular or plural forms, as

5009−`book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,

5010−`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`,

5011−`fol.`/`fols.`; `number`, `no.`/`nos.`; `line`, `l.`/`ll.`;

5012−`note`, `n.`/`nn.`; `opus`, `op.`/`opp.`; `page`, `p.`/`pp.`;

5013−`paragraph`, `para.`/`paras.`; `part`, `pt.`/`pts.`; `section`,

5014−`sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`; `verse`,

5015−`v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no

5016−locator term is used, "page" is assumed.

3433+An inline link consists of the link text in square brackets,

3434+followed by the URL in parentheses. (Optionally, the URL can

3435+be followed by a link title, in quotes.)

50173436

5018−In complex cases, you can force something to be treated as

5019−a locator by enclosing it in curly braces or prevent parsing

5020−the suffix as locator by prepending curly braces:

3437+ This is an [inline link](/url), and here's [one with

3438+ a title](http://fsf.org "click here for a good time!").

50213439

5022− [@smith{ii, A, D-Z}, with a suffix]

5023− [@smith, {pp. iv, vi-xi, (xv)-(xvii)} with suffix here]

5024− [@smith{}, 99 years later]

3440+There can be no space between the bracketed part and the parenthesized part.

3441+The link text can contain formatting (such as emphasis), but the title cannot.

50253442

5026−A minus sign (`-`) before the `@` will suppress mention of

5027−the author in the citation. This can be useful when the

5028−author is already mentioned in the text:

3443+Email addresses in inline links are not autodetected, so they have to be

3444+prefixed with `mailto`:

50293445

5030− Smith says blah [-@smith04].

3446+ [Write me!](mailto:sam@green.eggs.ham)

50313447

5032−You can also write an author-in-text citation, by omitting the

5033−square brackets:

3448+### Reference links ###

50343449

5035− @smith04 says blah.

3450+An *explicit* reference link has two parts, the link itself and the link

3451+definition, which may occur elsewhere in the document (either

3452+before or after the link).

50363453

5037− @smith04 [p. 33] says blah.

3454+The link consists of link text in square brackets, followed by a label in

3455+square brackets. (There cannot be space between the two unless the

3456+`spaced_reference_links` extension is enabled.) The link definition

3457+consists of the bracketed label, followed by a colon and a space, followed by

3458+the URL, and optionally (after a space) a link title either in quotes or in

3459+parentheses. The label must not be parseable as a citation (assuming

3460+the `citations` extension is enabled): citations take precedence over

3461+link labels.

50383462

5039−This will cause the author's name to be rendered, followed by

5040−the bibliographical details. Use this form when you want to

5041−make the citation the subject of a sentence.

5042−

5043−When you are using a note style, it is usually better to let

5044−citeproc create the footnotes from citations rather than writing

5045−an explicit note. If you do write an explicit note that

5046−contains a citation, note that normal citations will be put in

5047−parentheses, while author-in-text citations will not. For

5048−this reason, it is sometimes preferable to use the

5049−author-in-text style inside notes when using a note style.

5050−

5051−[CSL user documentation]: https://citationstyles.org/authors/

5052−[CSL]: https://docs.citationstyles.org/en/stable/specification.html

5053−[CSL markup specs]: https://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields

5054−[Chicago Manual of Style]: https://chicagomanualofstyle.org

5055−[Citation Style Language]: https://citationstyles.org

5056−[Zotero Style Repository]: https://www.zotero.org/styles

5057−[finding and editing styles]: https://citationstyles.org/authors/

5058−[CSL locale files]: https://github.com/citation-style-language/locales

3463+Here are some examples:

50593464

5060−## Non-default extensions

3465+ [my label 1]: /foo/bar.html "My title, optional"

3466+ [my label 2]: /foo

3467+ [my label 3]: http://fsf.org (The free software foundation)

3468+ [my label 4]: /bar#special 'A title in single quotes'

50613469

5062−The following Markdown syntax extensions are not enabled by default

5063−in pandoc, but may be enabled by adding `+EXTENSION` to the format

5064−name, where `EXTENSION` is the name of the extension. Thus, for

5065−example, `markdown+hard_line_breaks` is Markdown with hard line breaks.

3470+The URL may optionally be surrounded by angle brackets:

50663471

5067−#### Extension: `rebase_relative_paths` ####

5068−

5069−Rewrite relative paths for Markdown links and images, depending

5070−on the path of the file containing the link or image link. For

5071−each link or image, pandoc will compute the directory of the

5072−containing file, relative to the working directory, and prepend

5073−the resulting path to the link or image path.

5074−

5075−The use of this extension is best understood by example.

5076−Suppose you have a a subdirectory for each chapter of a book,

5077−`chap1`, `chap2`, `chap3`. Each contains a file `text.md` and a

5078−number of images used in the chapter. You would like to have

5079−`` in `chap1/text.md` refer to

5080−`chap1/spider.jpg` and `` in `chap2/text.md`

5081−refer to `chap2/spider.jpg`. To do this, use

5082−

5083− pandoc chap*/*.md -f markdown+rebase_relative_paths

5084−

5085−Without this extension, you would have to use

5086−`` in `chap1/text.md` and

5087−`` in `chap2/text.md`. Links with

5088−relative paths will be rewritten in the same way as images.

5089−

5090−Absolute paths and URLs are not changed. Neither are empty

5091−paths or paths consisting entirely of a fragment, e.g., `#foo`.

5092−

5093−Note that relative paths in reference links and images will

5094−be rewritten relative to the file containing the link

5095−reference definition, not the file containing the reference link

5096−or image itself, if these differ.

5097−

5098−#### Extension: `attributes` ####

5099−

5100−Allows attributes to be attached to any inline or block-level

5101−element. The syntax for the attributes is the same as that

5102−used in [`header_attributes`][Extension: `header_attributes`].

5103−

5104−- Attributes that occur immediately after an inline

5105− element affect that element. If they follow a space, then they

5106− belong to the space. (Hence, this option subsumes

5107− `inline_code_attributes` and `link_attributes`.)

5108−- Attributes that occur immediately before a block

5109− element, on a line by themselves, affect that

5110− element.

5111−- Consecutive attribute specifiers may be used,

5112− either for blocks or for inlines. Their attributes

5113− will be combined.

5114−- Attributes that occur at the end of the text of

5115− a Setext or ATX heading (separated by whitespace

5116− from the text) affect the heading element. (Hence, this

5117− option subsumes `header_attributes`.)

5118−- Attributes that occur after the opening fence

5119− in a fenced code block affect the code block element. (Hence,

5120− this option subsumes `fenced_code_attributes`.)

5121−- Attributes that occur at the end of a reference

5122− link definition affect links that refer to that

5123− definition.

5124−

5125−Note that pandoc's AST does not currently allow attributes

5126−to be attached to arbitrary elements. Hence a Span or Div

5127−container will be added if needed.

3472+ [my label 5]: <http://foo.bar.baz>

51283473

5129−#### Extension: `old_dashes` ####

3474+The title may go on the next line:

51303475

5131−Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes:

5132−`-` before a numeral is an en-dash, and `--` is an em-dash.

5133−This option only has an effect if `smart` is enabled. It is

5134−selected automatically for `textile` input.

3476+ [my label 3]: http://fsf.org

3477+ "The free software foundation"

51353478

5136−#### Extension: `angle_brackets_escapable` ####

3479+Note that link labels are not case sensitive. So, this will work:

51373480

5138−Allow `<` and `>` to be backslash-escaped, as they can be in

5139−GitHub flavored Markdown but not original Markdown. This is

5140−implied by pandoc's default `all_symbols_escapable`.

3481+ Here is [my link][FOO]

51413482

5142−#### Extension: `lists_without_preceding_blankline` ####

3483+ [Foo]: /bar/baz

51433484

5144−Allow a list to occur right after a paragraph, with no intervening

5145−blank space.

3485+In an *implicit* reference link, the second pair of brackets is

3486+empty:

51463487

5147−#### Extension: `four_space_rule` ####

3488+ See [my website][].

51483489

5149−Selects the pandoc <= 2.0 behavior for parsing lists, so that

5150−four spaces indent are needed for list item continuation

5151−paragraphs.

3490+ [my website]: http://foo.bar.baz

51523491

5153−#### Extension: `spaced_reference_links` ####

3492+Note: In `Markdown.pl` and most other Markdown implementations,

3493+reference link definitions cannot occur in nested constructions

3494+such as list items or block quotes. Pandoc lifts this arbitrary

3495+seeming restriction. So the following is fine in pandoc, though

3496+not in most other implementations:

51543497

5155−Allow whitespace between the two components of a reference link,

5156−for example,

3498+ > My block [quote].

3499+ >

3500+ > [quote]: /foo

51573501

5158− [foo] [bar].

3502+#### Extension: `shortcut_reference_links` ####

51593503

5160−#### Extension: `hard_line_breaks` ####

3504+In a *shortcut* reference link, the second pair of brackets may

3505+be omitted entirely:

51613506

5162−Causes all newlines within a paragraph to be interpreted as hard line

5163−breaks instead of spaces.

3507+ See [my website].

51643508

5165−#### Extension: `ignore_line_breaks` ####

3509+ [my website]: http://foo.bar.baz

51663510

5167−Causes newlines within a paragraph to be ignored, rather than being

5168−treated as spaces or as hard line breaks. This option is intended for

5169−use with East Asian languages where spaces are not used between words,

5170−but text is divided into lines for readability.

3511+### Internal links ###

51713512

5172−#### Extension: `east_asian_line_breaks` ####

3513+To link to another section of the same document, use the automatically

3514+generated identifier (see [Header identifiers]). For example:

51733515

5174−Causes newlines within a paragraph to be ignored, rather than

5175−being treated as spaces or as hard line breaks, when they occur

5176−between two East Asian wide characters. This is a better choice

5177−than `ignore_line_breaks` for texts that include a mix of East

5178−Asian wide characters and other characters.

3516+ See the [Introduction](#introduction).

51793517

5180−#### Extension: `emoji` ####

3518+or

51813519

5182−Parses textual emojis like `:smile:` as Unicode emoticons.

3520+ See the [Introduction].

51833521

5184−#### Extension: `tex_math_single_backslash` ####

3522+ [Introduction]: #introduction

51853523

5186−Causes anything between `\(` and `\)` to be interpreted as inline

5187−TeX math, and anything between `\[` and `\]` to be interpreted

5188−as display TeX math. Note: a drawback of this extension is that

5189−it precludes escaping `(` and `[`.

3524+Internal links are currently supported for HTML formats (including

3525+HTML slide shows and EPUB), LaTeX, and ConTeXt.

51903526

5191−#### Extension: `tex_math_double_backslash` ####

3527+Images

3528+------

51923529

5193−Causes anything between `\\(` and `\\)` to be interpreted as inline

5194−TeX math, and anything between `\\[` and `\\]` to be interpreted

5195−as display TeX math.

3530+A link immediately preceded by a `!` will be treated as an image.

3531+The link text will be used as the image's alt text:

51963532

5197−#### Extension: `markdown_attribute` ####

3533+ 

51983534

5199−By default, pandoc interprets material inside block-level tags as Markdown.

5200−This extension changes the behavior so that Markdown is only parsed

5201−inside block-level tags if the tags have the attribute `markdown=1`.

3535+ ![movie reel]

52023536

5203−#### Extension: `mmd_title_block` ####

3537+ [movie reel]: movie.gif

52043538

5205−Enables a [MultiMarkdown] style title block at the top of

5206−the document, for example:

3539+#### Extension: `implicit_figures` ####

52073540

5208− Title: My title

5209− Author: John Doe

5210− Date: September 1, 2008

5211− Comment: This is a sample mmd title block, with

5212− a field spanning multiple lines.

3541+An image with nonempty alt text, occurring by itself in a

3542+paragraph, will be rendered as a figure with a caption. The

3543+image's alt text will be used as the caption.

52133544

5214−See the MultiMarkdown documentation for details. If `pandoc_title_block` or

5215−`yaml_metadata_block` is enabled, it will take precedence over

5216−`mmd_title_block`.

3545+ 

52173546

5218−#### Extension: `abbreviations` ####

3547+How this is rendered depends on the output format. Some output

3548+formats (e.g. RTF) do not yet support figures. In those

3549+formats, you'll just get an image in a paragraph by itself, with

3550+no caption.

52193551

5220−Parses PHP Markdown Extra abbreviation keys, like

3552+If you just want a regular inline image, just make sure it is not

3553+the only thing in the paragraph. One way to do this is to insert a

3554+nonbreaking space after the image:

52213555

5222− *[HTML]: Hypertext Markup Language

3556+ \

52233557

5224−Note that the pandoc document model does not support

5225−abbreviations, so if this extension is enabled, abbreviation keys are

5226−simply skipped (as opposed to being parsed as paragraphs).

3558+Note that in reveal.js slide shows, an image in a paragraph

3559+by itself that has the `stretch` class will fill the screen,

3560+and the caption and figure tags will be omitted.

52273561

5228−#### Extension: `autolink_bare_uris` ####

3562+#### Extension: `link_attributes` ####

52293563

5230−Makes all absolute URIs into links, even when not surrounded by

5231−pointy braces `<...>`.

3564+Attributes can be set on links and images:

52323565

5233−#### Extension: `mmd_link_attributes` ####

3566+ An inline {#id .class width=30 height=20px}

3567+ and a reference ![image][ref] with attributes.

52343568

5235−Parses multimarkdown style key-value attributes on link

5236−and image references. This extension should not be confused with the

5237−[`link_attributes`](#extension-link_attributes) extension.

3569+ [ref]: foo.jpg "optional title" {#id .class key=val key2="val 2"}

52383570

5239− This is a reference ![image][ref] with multimarkdown attributes.

3571+(This syntax is compatible with [PHP Markdown Extra] when only `#id`

3572+and `.class` are used.)

52403573

5241− [ref]: https://path.to/image "Image title" width=20px height=30px

5242− id=myId class="myClass1 myClass2"

3574+For HTML and EPUB, all attributes except `width` and `height` (but

3575+including `srcset` and `sizes`) are passed through as is. The other

3576+writers ignore attributes that are not supported by their output

3577+format.

52433578

5244−#### Extension: `mmd_header_identifiers` ####

3579+The `width` and `height` attributes on images are treated specially. When

3580+used without a unit, the unit is assumed to be pixels. However, any of

3581+the following unit identifiers can be used: `px`, `cm`, `mm`, `in`, `inch`

3582+and `%`. There must not be any spaces between the number and the unit.

3583+For example:

52453584

5246−Parses multimarkdown style heading identifiers (in square brackets,

5247−after the heading but before any trailing `#`s in an ATX heading).

3585+```

3586+{ width=50% }

3587+```

52483588

5249−#### Extension: `compact_definition_lists` ####

3589+- Dimensions are converted to inches for output in page-based formats like

3590+ LaTeX. Dimensions are converted to pixels for output in HTML-like

3591+ formats. Use the `--dpi` option to specify the number of pixels per

3592+ inch. The default is 96dpi.

3593+- The `%` unit is generally relative to some available space.

3594+ For example the above example will render to

3595+ `<img href="file.jpg" style="width: 50%;" />` (HTML),

3596+ `\includegraphics[width=0.5\textwidth]{file.jpg}` (LaTeX), or

3597+ `\externalfigure[file.jpg][width=0.5\textwidth]` (ConTeXt).

3598+- Some output formats have a notion of a class

3599+ ([ConTeXt](http://wiki.contextgarden.net/Using_Graphics#Multiple_Image_Settings))

3600+ or a unique identifier (LaTeX `\caption`), or both (HTML).

3601+- When no `width` or `height` attributes are specified, the fallback

3602+ is to look at the image resolution and the dpi metadata embedded in

3603+ the image file.

52503604

5251−Activates the definition list syntax of pandoc 1.12.x and earlier.

5252−This syntax differs from the one described above under [Definition lists]

5253−in several respects:

3605+Spans

3606+-----

52543607

5255− - No blank line is required between consecutive items of the

5256− definition list.

5257− - To get a "tight" or "compact" list, omit space between consecutive

5258− items; the space between a term and its definition does not affect

5259− anything.

5260− - Lazy wrapping of paragraphs is not allowed: the entire definition must

5261− be indented four spaces.[^6]

3608+#### Extension: `bracketed_spans` ####

52623609

5263−[^6]: To see why laziness is incompatible with relaxing the requirement

5264− of a blank line between items, consider the following example:

3610+A bracketed sequence of inlines, as one would use to begin

3611+a link, will be treated as a span with attributes if it is

3612+followed immediately by attributes:

52653613

5266− bar

5267− : definition

5268− foo

5269− : definition

3614+ [This is *some text*]{.class key="val"}

52703615

5271− Is this a single list item with two definitions of "bar," the first of

5272− which is lazily wrapped, or two list items? To remove the ambiguity

5273− we must either disallow lazy wrapping or require a blank line between

5274− list items.

3616+Footnotes

3617+---------

52753618

5276−#### Extension: `gutenberg` ####

3619+#### Extension: `footnotes` ####

52773620

5278−Use [Project Gutenberg] conventions for `plain` output:

5279−all-caps for strong emphasis, surround by underscores

5280−for regular emphasis, add extra blank space around headings.

3621+Pandoc's Markdown allows footnotes, using the following syntax:

52813622

5282− [Project Gutenberg]: https://www.gutenberg.org

3623+ Here is a footnote reference,[^1] and another.[^longnote]

52833624

5284−#### Extension: `sourcepos` ####

3625+ [^1]: Here is the footnote.

52853626

5286−Include source position attributes when parsing `commonmark`.

5287−For elements that accept attributes, a `data-pos` attribute

5288−is added; other elements are placed in a surrounding

5289−Div or Span elemnet with a `data-pos` attribute.

3627+ [^longnote]: Here's one with multiple blocks.

52903628

5291−## Markdown variants

3629+ Subsequent paragraphs are indented to show that they

3630+ belong to the previous footnote.

52923631

5293−In addition to pandoc's extended Markdown, the following Markdown

5294−variants are supported:

3632+ { some.code }

3633+

3634+ The whole paragraph can be indented, or just the first

3635+ line. In this way, multi-paragraph footnotes work like

3636+ multi-paragraph list items.

52953637

5296−- `markdown_phpextra` (PHP Markdown Extra)

5297−- `markdown_github` (deprecated GitHub-Flavored Markdown)

5298−- `markdown_mmd` (MultiMarkdown)

5299−- `markdown_strict` (Markdown.pl)

5300−- `commonmark` (CommonMark)

5301−- `gfm` (Github-Flavored Markdown)

5302−- `commonmark_x` (CommonMark with many pandoc extensions)

3638+ This paragraph won't be part of the note, because it

3639+ isn't indented.

53033640

5304−To see which extensions are supported for a given format,

5305−and which are enabled by default, you can use the command

3641+The identifiers in footnote references may not contain spaces, tabs,

3642+or newlines. These identifiers are used only to correlate the

3643+footnote reference with the note itself; in the output, footnotes

3644+will be numbered sequentially.

53063645

5307− pandoc --list-extensions=FORMAT

3646+The footnotes themselves need not be placed at the end of the

3647+document. They may appear anywhere except inside other block elements

3648+(lists, block quotes, tables, etc.). Each footnote should be

3649+separated from surrounding content (including other footnotes)

3650+by blank lines.

53083651

5309−where `FORMAT` is replaced with the name of the format.

3652+#### Extension: `inline_notes` ####

53103653

5311−Note that the list of extensions for `commonmark`,

5312−`gfm`, and `commonmark_x` are defined relative to default

5313−commonmark. So, for example, `backtick_code_blocks`

5314−does not appear as an extension, since it is enabled by

5315−default and cannot be disabled.

3654+Inline footnotes are also allowed (though, unlike regular notes,

3655+they cannot contain multiple paragraphs). The syntax is as follows:

53163656

5317−# Citations

3657+ Here is an inline note.^[Inlines notes are easier to write, since

3658+ you don't have to pick an identifier and move down to type the

3659+ note.]

53183660

5319−When the `--citeproc` option is used, pandoc can automatically generate

5320−citations and a bibliography in a number of styles. Basic usage is

3661+Inline and regular footnotes may be mixed freely.

53213662

5322− pandoc --citeproc myinput.txt

3663+Citations

3664+---------

53233665

5324−To use this feature, you will need to have

3666+#### Extension: `citations` ####

53253667

5326−- a document containing citations (see [Extension: `citations`]);

5327−- a source of bibliographic data: either an external bibliography

5328− file or a list of `references` in the document's YAML metadata

5329−- optionally, a [CSL] citation style.

3668+Using an external filter, `pandoc-citeproc`, pandoc can automatically generate

3669+citations and a bibliography in a number of styles. Basic usage is

53303670

5331−## Specifying bibliographic data

3671+ pandoc --filter pandoc-citeproc myinput.txt

53323672

5333−You can specify an external bibliography using the

5334−`bibliography` metadata field in a YAML metadata section or the

5335−`--bibliography` command line argument. If you want to use

5336−multiple bibliography files, you can supply multiple

5337−`--bibliography` arguments or set `bibliography` metadata field

5338−to YAML array. A bibliography may have any of these formats:

3673+In order to use this feature, you will need to specify a bibliography file

3674+using the `bibliography` metadata field in a YAML metadata section, or

3675+`--bibliography` command line argument. You can supply multiple `--bibliography`

3676+arguments or set `bibliography` metadata field to YAML array, if you want to

3677+use multiple bibliography files. The bibliography may have any of these

3678+formats:

53393679

53403680 Format File extension

53413681 ------------ --------------

53423682 BibLaTeX .bib

53433683 BibTeX .bibtex

3684+ Copac .copac

53443685 CSL JSON .json

53453686 CSL YAML .yaml

3687+ EndNote .enl

3688+ EndNote XML .xml

3689+ ISI .wos

3690+ MEDLINE .medline

3691+ MODS .mods

3692+ RIS .ris

53463693

53473694Note that `.bib` can be used with both BibTeX and BibLaTeX files;

5348−use the extension `.bibtex` to force interpretation as BibTeX.

3695+use `.bibtex` to force BibTeX.

3696+

3697+Note that `pandoc-citeproc --bib2json` and `pandoc-citeproc --bib2yaml`

3698+can produce `.json` and `.yaml` files from any of the supported formats.

53493699

5350−In BibTeX and BibLaTeX databases, pandoc parses LaTeX markup

5351−inside fields such as `title`; in CSL YAML databases, pandoc

5352−Markdown; and in CSL JSON databases, an [HTML-like markup][CSL

5353−markup specs]:

3700+In-field markup: In BibTeX and BibLaTeX databases, pandoc-citeproc parses

3701+a subset of LaTeX markup; in CSL YAML databases, pandoc Markdown; and in CSL JSON databases, an [HTML-like markup][CSL markup specs]:

53543702

53553703`<i>...</i>`

53563704: italics

@@ -5370,11 +3718,14 @@ markup specs]:

53703718`<span class="nocase">...</span>`

53713719: prevent a phrase from being capitalized as title case

53723720

5373−As an alternative to specifying a bibliography file using

5374−`--bibliography` or the YAML metadata field `bibliography`, you

5375−can include the citation data directly in the `references` field

5376−of the document's YAML metadata. The field should contain an

5377−array of YAML-encoded references, for example:

3721+`pandoc-citeproc -j` and `-y` interconvert the CSL JSON

3722+and CSL YAML formats as far as possible.

3723+

3724+As an alternative to specifying a bibliography file using `--bibliography`

3725+or the YAML metadata field `bibliography`, you can include

3726+the citation data directly in the `references` field of the

3727+document's YAML metadata. The field should contain an array of

3728+YAML-encoded references, for example:

53783729

53793730 ---

53803731 references:

@@ -5390,273 +3741,322 @@ array of YAML-encoded references, for example:

53903741 - - 1953

53913742 - 4

53923743 - 25

5393− title: 'Molecular structure of nucleic acids: a structure for

5394− deoxyribose nucleic acid'

3744+ title: 'Molecular structure of nucleic acids: a structure for deoxyribose

3745+ nucleic acid'

53953746 title-short: Molecular structure of nucleic acids

53963747 container-title: Nature

53973748 volume: 171

53983749 issue: 4356

53993750 page: 737-738

54003751 DOI: 10.1038/171737a0

5401− URL: https://www.nature.com/articles/171737a0

3752+ URL: http://www.nature.com/nature/journal/v171/n4356/abs/171737a0.html

54023753 language: en-GB

54033754 ...

54043755

5405−If both an external bibliography and inline (YAML metadata)

5406−references are provided, both will be used. In case of

5407−conflicting `id`s, the inline references will take precedence.

3756+(`pandoc-citeproc --bib2yaml` can produce these from a bibliography file in one

3757+of the supported formats.)

3758+

3759+Citations and references can be formatted using any style supported by the

3760+[Citation Style Language], listed in the [Zotero Style Repository].

3761+These files are specified using the `--csl` option or the `csl` metadata field.

3762+By default, `pandoc-citeproc` will use the [Chicago Manual of Style] author-date

3763+format. The CSL project provides further information on [finding and editing styles].

3764+

3765+To make your citations hyperlinks to the corresponding bibliography

3766+entries, add `link-citations: true` to your YAML metadata.

3767+

3768+Citations go inside square brackets and are separated by semicolons.

3769+Each citation must have a key, composed of '@' + the citation

3770+identifier from the database, and may optionally have a prefix,

3771+a locator, and a suffix. The citation key must begin with a letter, digit,

3772+or `_`, and may contain alphanumerics, `_`, and internal punctuation

3773+characters (`:.#$%&-+?<>~/`). Here are some examples:

3774+

3775+ Blah blah [see @doe99, pp. 33-35; also @smith04, chap. 1].

3776+

3777+ Blah blah [@doe99, pp. 33-35, 38-39 and *passim*].

3778+

3779+ Blah blah [@smith04; @doe99].

3780+

3781+`pandoc-citeproc` detects locator terms in the [CSL locale files].

3782+Either abbreviated or unabbreviated forms are accepted. In the `en-US`

3783+locale, locator terms can be written in either singular or plural forms,

3784+as `book`, `bk.`/`bks.`; `chapter`, `chap.`/`chaps.`; `column`,

3785+`col.`/`cols.`; `figure`, `fig.`/`figs.`; `folio`, `fol.`/`fols.`;

3786+`number`, `no.`/`nos.`; `line`, `l.`/`ll.`; `note`, `n.`/`nn.`; `opus`,

3787+`op.`/`opp.`; `page`, `p.`/`pp.`; `paragraph`, `para.`/`paras.`; `part`,

3788+`pt.`/`pts.`; `section`, `sec.`/`secs.`; `sub verbo`, `s.v.`/`s.vv.`;

3789+`verse`, `v.`/`vv.`; `volume`, `vol.`/`vols.`; `¶`/`¶¶`; `§`/`§§`. If no

3790+locator term is used, "page" is assumed.

3791+

3792+A minus sign (`-`) before the `@` will suppress mention of

3793+the author in the citation. This can be useful when the

3794+author is already mentioned in the text:

3795+

3796+ Smith says blah [-@smith04].

3797+

3798+You can also write an in-text citation, as follows:

3799+

3800+ @smith04 says blah.

3801+

3802+ @smith04 [p. 33] says blah.

3803+

3804+If the style calls for a list of works cited, it will be placed

3805+at the end of the document. Normally, you will want to end your

3806+document with an appropriate header:

3807+

3808+ last paragraph...

3809+

3810+ # References

54083811

5409−Note that `pandoc` can be used to produce such a YAML metadata

5410−section from a BibTeX, BibLaTeX, or CSL JSON bibliography:

3812+The bibliography will be inserted after this header. Note that

3813+the `unnumbered` class will be added to this header, so that the

3814+section will not be numbered.

54113815

5412− pandoc chem.bib -s -f biblatex -t markdown

5413− pandoc chem.json -s -f csljson -t markdown

3816+If you want to include items in the bibliography without actually

3817+citing them in the body text, you can define a dummy `nocite` metadata

3818+field and put the citations there:

54143819

5415−Indeed, `pandoc` can convert between any of these

5416−citation formats:

3820+ ---

3821+ nocite: |

3822+ @item1, @item2

3823+ ...

54173824

5418− pandoc chem.bib -s -f biblatex -t csljson

5419− pandoc chem.yaml -s -f markdown -t biblatex

3825+ @item3

54203826

5421−Running pandoc on a bibliography file with the `--citeproc`

5422−option will create a formatted bibliography in the format

5423−of your choice:

3827+In this example, the document will contain a citation for `item3`

3828+only, but the bibliography will contain entries for `item1`, `item2`, and

3829+`item3`.

54243830

5425− pandoc chem.bib -s --citeproc -o chem.html

5426− pandoc chem.bib -s --citeproc -o chem.pdf

3831+It is possible to create a bibliography with all the citations,

3832+whether or not they appear in the document, by using a wildcard:

54273833

5428−### Capitalization in titles

3834+ ---

3835+ nocite: |

3836+ @*

3837+ ...

54293838

5430−If you are using a bibtex or biblatex bibliography, then observe

5431−the following rules:

3839+For LaTeX or PDF output, you can also use [`natbib`] or [`biblatex`]

3840+to render bibliography. In order to do so, specify bibliography files as

3841+outlined above, and add `--natbib` or `--biblatex` argument to `pandoc`

3842+invocation. Bear in mind that bibliography files have to be in respective

3843+format (either BibTeX or BibLaTeX).

54323844

5433− - English titles should be in title case. Non-English titles should

5434− be in sentence case, and the `langid` field in biblatex should be

5435− set to the relevant language. (The following values are treated

5436− as English: `american`, `british`, `canadian`, `english`,

5437− `australian`, `newzealand`, `USenglish`, or `UKenglish`.)

3845+For more information, see the [pandoc-citeproc man page].

54383846

5439− - As is standard with bibtex/biblatex, proper names should be

5440− protected with curly braces so that they won't be lowercased

5441− in styles that call for sentence case. For example:

3847+[CSL markup specs]: http://docs.citationstyles.org/en/1.0/release-notes.html#rich-text-markup-within-fields

3848+[Chicago Manual of Style]: http://chicagomanualofstyle.org

3849+[Citation Style Language]: http://citationstyles.org

3850+[Zotero Style Repository]: https://www.zotero.org/styles

3851+[finding and editing styles]: http://citationstyles.org/styles/

3852+[CSL locale files]: https://github.com/citation-style-language/locales

3853+[pandoc-citeproc man page]: https://github.com/jgm/pandoc-citeproc/blob/master/man/pandoc-citeproc.1.md

54423854

5443− title = {My Dinner with {Andre}}

3855+Non-pandoc extensions

3856+---------------------

54443857

5445− - In addition, words that should remain lowercase (or camelCase)

5446− should be protected:

3858+The following Markdown syntax extensions are not enabled by default

3859+in pandoc, but may be enabled by adding `+EXTENSION` to the format

3860+name, where `EXTENSION` is the name of the extension. Thus, for

3861+example, `markdown+hard_line_breaks` is Markdown with hard line breaks.

54473862

5448− title = {Spin Wave Dispersion on the {nm} Scale}

3863+#### Extension: `old_dashes` ####

54493864

5450− Though this is not necessary in bibtex/biblatex, it is necessary

5451− with citeproc, which stores titles internally in sentence case,

5452− and converts to title case in styles that require it. Here we

5453− protect "nm" so that it doesn't get converted to "Nm" at this stage.

3865+Selects the pandoc <= 1.8.2.1 behavior for parsing smart dashes:

3866+`-` before a numeral is an en-dash, and `--` is an em-dash.

3867+This option only has an effect if `smart` is enabled. It is

3868+selected automatically for `textile` input.

54543869

5455−If you are using a CSL bibliography (either JSON or YAML), then observe

5456−the following rules:

3870+#### Extension: `angle_brackets_escapable` ####

54573871

5458− - All titles should be in sentence case.

3872+Allow `<` and `>` to be backslash-escaped, as they can be in

3873+GitHub flavored Markdown but not original Markdown. This is

3874+implied by pandoc's default `all_symbols_escapable`.

54593875

5460− - Use the `language` field for non-English titles to prevent their

5461− conversion to title case in styles that call for this. (Conversion

5462− happens only if `language` begins with `en` or is left empty.)

3876+#### Extension: `lists_without_preceding_blankline` ####

54633877

5464− - Protect words that should not be converted to title case using

5465− this syntax:

3878+Allow a list to occur right after a paragraph, with no intervening

3879+blank space.

54663880

5467− Spin wave dispersion on the <span class="nocase">nm</span> scale

3881+#### Extension: `four_space_rule` ####

54683882

5469−### Conference Papers, Published vs. Unpublished

3883+Selects the pandoc <= 2.0 behavior for parsing lists, so that

3884+four spaces indent are needed for list item continuation

3885+paragraphs.

54703886

5471−For a formally published conference paper, use the biblatex entry type

5472−`inproceedings` (which will be mapped to CSL `paper-conference`).

3887+#### Extension: `spaced_reference_links` ####

54733888

5474−For an unpublished manuscript, use the biblatex entry type

5475−`unpublished` without an `eventtitle` field (this entry type

5476−will be mapped to CSL `manuscript`).

3889+Allow whitespace between the two components of a reference link,

3890+for example,

54773891

5478−For a talk, an unpublished conference paper, or a poster

5479−presentation, use the biblatex entry type `unpublished` with an

5480−`eventtitle` field (this entry type will be mapped to CSL

5481−`speech`). Use the biblatex `type` field to indicate the type,

5482−e.g. "Paper", or "Poster". `venue` and `eventdate` may be useful

5483−too, though `eventdate` will not be rendered by most CSL styles.

5484−Note that `venue` is for the event's venue, unlike `location`

5485−which describes the publisher's location; do not use the latter

5486−for an unpublished conference paper.

3892+ [foo] [bar].

54873893

3894+#### Extension: `hard_line_breaks` ####

54883895

5489−## Specifying a citation style

3896+Causes all newlines within a paragraph to be interpreted as hard line

3897+breaks instead of spaces.

54903898

5491−Citations and references can be formatted using any style supported by the

5492−[Citation Style Language], listed in the [Zotero Style Repository].

5493−These files are specified using the `--csl` option or the `csl`

5494−(or `citation-style`) metadata field. By default, pandoc will

5495−use the [Chicago Manual of Style] author-date format. (You can

5496−override this default by copying a CSL style of your choice

5497−to `default.csl` in your user data directory.)

5498−The CSL project provides further information on [finding and

5499−editing styles].

5500−

5501−The `--citation-abbreviations` option (or the

5502−`citation-abbreviations` metadata field) may be used to specify

5503−a JSON file containing abbreviations of journals that should be

5504−used in formatted bibliographies when `form="short"` is

5505−specified. The format of the file can be illustrated with an

5506−example:

3899+#### Extension: `ignore_line_breaks` ####

55073900

3901+Causes newlines within a paragraph to be ignored, rather than being

3902+treated as spaces or as hard line breaks. This option is intended for

3903+use with East Asian languages where spaces are not used between words,

3904+but text is divided into lines for readability.

55083905

5509− { "default": {

5510− "container-title": {

5511− "Lloyd's Law Reports": "Lloyd's Rep",

5512− "Estates Gazette": "EG",

5513− "Scots Law Times": "SLT"

5514− }

5515− }

5516− }

3906+#### Extension: `east_asian_line_breaks` ####

55173907

3908+Causes newlines within a paragraph to be ignored, rather than

3909+being treated as spaces or as hard line breaks, when they occur

3910+between two East Asian wide characters. This is a better choice

3911+than `ignore_line_breaks` for texts that include a mix of East

3912+Asian wide characters and other characters.

55183913

5519−## Citations in note styles

3914+#### Extension: `emoji` ####

55203915

5521−Pandoc's citation processing is designed to allow you to

5522−move between author-date, numerical, and note styles without

5523−modifying the markdown source. When you're using a note

5524−style, avoid inserting footnotes manually. Instead, insert

5525−citations just as you would in an author-date style---for

5526−example,

3916+Parses textual emojis like `:smile:` as Unicode emoticons.

55273917

5528− Blah blah [@foo, p. 33].

3918+#### Extension: `tex_math_single_backslash` ####

55293919

5530−The footnote will be created automatically. Pandoc will take

5531−care of removing the space and moving the note before or

5532−after the period, depending on the setting of

5533−`notes-after-punctuation`, as described below in [Other relevant

5534−metadata fields].

3920+Causes anything between `\(` and `\)` to be interpreted as inline

3921+TeX math, and anything between `\[` and `\]` to be interpreted

3922+as display TeX math. Note: a drawback of this extension is that

3923+it precludes escaping `(` and `[`.

55353924

5536−In some cases you may need to put a citation inside a regular

5537−footnote. Normal citations in footnotes (such as `[@foo, p.

5538−33]`) will be rendered in parentheses. In-text citations (such

5539−as `@foo [p. 33]`) will be rendered without parentheses. (A

5540−comma will be added if appropriate.) Thus:

3925+#### Extension: `tex_math_double_backslash` ####

55413926

5542− [^1]: Some studies [@foo; @bar, p. 33] show that

5543− frubulicious zoosnaps are quantical. For a survey

5544− of the literature, see @baz [chap. 1].

3927+Causes anything between `\\(` and `\\)` to be interpreted as inline

3928+TeX math, and anything between `\\[` and `\\]` to be interpreted

3929+as display TeX math.

55453930

5546−## Raw content in a style

3931+#### Extension: `markdown_attribute` ####

55473932

5548−To include raw content in a prefix, suffix, delimiter, or term,

5549−surround it with these tags indicating the format:

3933+By default, pandoc interprets material inside block-level tags as Markdown.

3934+This extension changes the behavior so that Markdown is only parsed

3935+inside block-level tags if the tags have the attribute `markdown=1`.

55503936

5551− {{jats}}&lt;ref&gt;{{/jats}}

3937+#### Extension: `mmd_title_block` ####

55523938

5553−Without the tags, the string will be interpreted as a string

5554−and escaped in the output, rather than being passed through raw.

3939+Enables a [MultiMarkdown] style title block at the top of

3940+the document, for example:

55553941

5556−This feature allows stylesheets to be customized to give

5557−different output for different output formats. However,

5558−stylesheets customized in this way will not be usable

5559−by other CSL implementations.

3942+ Title: My title

3943+ Author: John Doe

3944+ Date: September 1, 2008

3945+ Comment: This is a sample mmd title block, with

3946+ a field spanning multiple lines.

55603947

3948+See the MultiMarkdown documentation for details. If `pandoc_title_block` or

3949+`yaml_metadata_block` is enabled, it will take precedence over

3950+`mmd_title_block`.

55613951

3952+#### Extension: `abbreviations` ####

55623953

5563−## Placement of the bibliography

3954+Parses PHP Markdown Extra abbreviation keys, like

55643955

5565−If the style calls for a list of works cited, it will be placed

5566−in a div with id `refs`, if one exists:

3956+ *[HTML]: Hypertext Markup Language

55673957

5568− ::: {#refs}

5569− :::

3958+Note that the pandoc document model does not support

3959+abbreviations, so if this extension is enabled, abbreviation keys are

3960+simply skipped (as opposed to being parsed as paragraphs).

55703961

5571−Otherwise, it will be placed at the end of the document.

5572−Generation of the bibliography can be suppressed by setting

5573−`suppress-bibliography: true` in the YAML metadata.

3962+#### Extension: `autolink_bare_uris` ####

55743963

5575−If you wish the bibliography to have a section heading, you can

5576−set `reference-section-title` in the metadata, or put the heading

5577−at the beginning of the div with id `refs` (if you are using it)

5578−or at the end of your document:

3964+Makes all absolute URIs into links, even when not surrounded by

3965+pointy braces `<...>`.

55793966

5580− last paragraph...

3967+#### Extension: `mmd_link_attributes` ####

55813968

5582− # References

3969+Parses multimarkdown style key-value attributes on link

3970+and image references. This extension should not be confused with the

3971+[`link_attributes`](#extension-link_attributes) extension.

55833972

5584−The bibliography will be inserted after this heading. Note that

5585−the `unnumbered` class will be added to this heading, so that the

5586−section will not be numbered.

3973+ This is a reference ![image][ref] with multimarkdown attributes.

55873974

5588−## Including uncited items in the bibliography

3975+ [ref]: http://path.to/image "Image title" width=20px height=30px

3976+ id=myId class="myClass1 myClass2"

55893977

5590−If you want to include items in the bibliography without actually

5591−citing them in the body text, you can define a dummy `nocite` metadata

5592−field and put the citations there:

3978+#### Extension: `mmd_header_identifiers` ####

55933979

5594− ---

5595− nocite: |

5596− @item1, @item2

5597− ...

3980+Parses multimarkdown style header identifiers (in square brackets,

3981+after the header but before any trailing `#`s in an ATX header).

55983982

5599− @item3

3983+#### Extension: `compact_definition_lists` ####

56003984

5601−In this example, the document will contain a citation for `item3`

5602−only, but the bibliography will contain entries for `item1`, `item2`, and

5603−`item3`.

3985+Activates the definition list syntax of pandoc 1.12.x and earlier.

3986+This syntax differs from the one described above under [Definition lists]

3987+in several respects:

56043988

5605−It is possible to create a bibliography with all the citations,

5606−whether or not they appear in the document, by using a wildcard:

3989+ - No blank line is required between consecutive items of the

3990+ definition list.

3991+ - To get a "tight" or "compact" list, omit space between consecutive

3992+ items; the space between a term and its definition does not affect

3993+ anything.

3994+ - Lazy wrapping of paragraphs is not allowed: the entire definition must

3995+ be indented four spaces.[^6]

56073996

5608− ---

5609− nocite: |

5610− @*

5611− ...

3997+[^6]: To see why laziness is incompatible with relaxing the requirement

3998+ of a blank line between items, consider the following example:

56123999

5613−For LaTeX output, you can also use [`natbib`] or [`biblatex`] to

5614−render the bibliography. In order to do so, specify bibliography

5615−files as outlined above, and add `--natbib` or `--biblatex`

5616−argument to `pandoc` invocation. Bear in mind that bibliography

5617−files have to be in either BibTeX (for `--natbib`)

5618−or BibLaTeX (for `--biblatex`) format.

4000+ bar

4001+ : definition

4002+ foo

4003+ : definition

56194004

5620−## Other relevant metadata fields

4005+ Is this a single list item with two definitions of "bar," the first of

4006+ which is lazily wrapped, or two list items? To remove the ambiguity

4007+ we must either disallow lazy wrapping or require a blank line between

4008+ list items.

56214009

5622−A few other metadata fields affect bibliography formatting:

4010+Markdown variants

4011+-----------------

56234012

5624−`link-citations`

5625−: If true, citations will be

5626− hyperlinked to the corresponding bibliography entries

5627− (for author-date and numerical styles only).

4013+In addition to pandoc's extended Markdown, the following Markdown

4014+variants are supported:

56284015

5629−`lang`

5630−: The `lang` field will affect how the style is localized,

5631− for example in the translation of labels, the use

5632− of quotation marks, and the way items are sorted.

5633− (For backwards compatibility, `locale` may be used instead

5634− of `lang`, but this use is deprecated.)

5635−

5636− A BCP 47 language tag is expected: for example, `en`,

5637− `de`, `en-US`, `fr-CA`, `ug-Cyrl`. The unicode extension

5638− syntax (after `-u-`) may be used to specify options for

5639− collation (sorting) more precisely. Here are some examples:

5640−

5641− - `zh-u-co-pinyin` -- Chinese with the Pinyin collation.

5642− - `es-u-co-trad` -- Spanish with the traditional collation

5643− (with `Ch` sorting after `C`).

5644− - `fr-u-kb` -- French with "backwards" accent sorting

5645− (with `coté` sorting after `côte`).

5646− - `en-US-u-kf-upper` -- English with uppercase letters sorting

5647− before lower (default is lower before upper).

5648−

5649−`notes-after-punctuation`

5650−: If true (the default), pandoc will put footnote citations

5651− after following punctuation. For example, if the source

5652− contains `blah blah [@jones99].`, the result will look like

5653− `blah blah.[^1]`, with the note moved after the period and

5654− the space collapsed. If false, the space will still be

5655− collapsed, but the footnote will not be moved after the

5656− punctuation.

5657−

5658−

5659−# Slide shows

4016+`markdown_phpextra` (PHP Markdown Extra)

4017+: `footnotes`, `pipe_tables`, `raw_html`, `markdown_attribute`,

4018+ `fenced_code_blocks`, `definition_lists`, `intraword_underscores`,

4019+ `header_attributes`, `link_attributes`, `abbreviations`,

4020+ `shortcut_reference_links`, `spaced_reference_links`.

4021+

4022+`markdown_github` (deprecated GitHub-Flavored Markdown)

4023+: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `gfm_auto_identifiers`,

4024+ `ascii_identifiers`, `backtick_code_blocks`, `autolink_bare_uris`,

4025+ `space_in_atx_header`, `intraword_underscores`, `strikeout`,

4026+ `emoji`, `shortcut_reference_links`, `angle_brackets_escapable`,

4027+ `lists_without_preceding_blankline`.

4028+

4029+`markdown_mmd` (MultiMarkdown)

4030+: `pipe_tables`, `raw_html`, `markdown_attribute`, `mmd_link_attributes`,

4031+ `tex_math_double_backslash`, `intraword_underscores`,

4032+ `mmd_title_block`, `footnotes`, `definition_lists`,

4033+ `all_symbols_escapable`, `implicit_header_references`,

4034+ `auto_identifiers`, `mmd_header_identifiers`,

4035+ `shortcut_reference_links`, `implicit_figures`,

4036+ `superscript`, `subscript`, `backtick_code_blocks`,

4037+ `spaced_reference_links`, `raw_attribute`.

4038+

4039+`markdown_strict` (Markdown.pl)

4040+: `raw_html`, `shortcut_reference_links`,

4041+ `spaced_reference_links`.

4042+

4043+We also support `commonmark` and `gfm` (GitHub-Flavored Markdown,

4044+which is implemented as a set of extensions on `commonmark`).

4045+

4046+Note, however, that `commonmark` and `gfm` have limited support

4047+for extensions. Only those listed below (and `smart` and

4048+`raw_tex`) will work. The extensions can, however, all be

4049+individually disabled.

4050+Also, `raw_tex` only affects `gfm` output, not input.

4051+

4052+`gfm` (GitHub-Flavored Markdown)

4053+: `pipe_tables`, `raw_html`, `fenced_code_blocks`, `auto_identifiers`,

4054+ `ascii_identifiers`, `backtick_code_blocks`, `autolink_bare_uris`,

4055+ `intraword_underscores`, `strikeout`, `hard_line_breaks`, `emoji`,

4056+ `shortcut_reference_links`, `angle_brackets_escapable`.

4057+

4058+Producing slide shows with pandoc

4059+=================================

56604060

56614061You can use pandoc to produce an HTML + JavaScript slide presentation

56624062that can be viewed via a web browser. There are five ways to do this,

@@ -5704,21 +4104,18 @@ To produce an HTML/JavaScript slide show, simply type

57044104

57054105where `FORMAT` is either `s5`, `slidy`, `slideous`, `dzslides`, or `revealjs`.

57064106

5707−For Slidy, Slideous, reveal.js, and S5, the file produced by

5708−pandoc with the `-s/--standalone` option embeds a link to

5709−JavaScript and CSS files, which are assumed to be available at

5710−the relative path `s5/default` (for S5), `slideous` (for

5711−Slideous), `reveal.js` (for reveal.js), or at the Slidy website

5712−at `w3.org` (for Slidy). (These paths can be changed by setting

5713−the `slidy-url`, `slideous-url`, `revealjs-url`, or `s5-url`

5714−variables; see [Variables for HTML slides], above.) For

5715−DZSlides, the (relatively short) JavaScript and CSS are included

5716−in the file by default.

5717−

5718−With all HTML slide formats, the `--self-contained` option can

5719−be used to produce a single file that contains all of the data

5720−necessary to display the slide show, including linked scripts,

5721−stylesheets, images, and videos.

4107+For Slidy, Slideous, reveal.js, and S5, the file produced by pandoc with the

4108+`-s/--standalone` option embeds a link to JavaScript and CSS files, which are

4109+assumed to be available at the relative path `s5/default` (for S5), `slideous`

4110+(for Slideous), `reveal.js` (for reveal.js), or at the Slidy website at

4111+`w3.org` (for Slidy). (These paths can be changed by setting the `slidy-url`,

4112+`slideous-url`, `revealjs-url`, or `s5-url` variables; see [Variables for slides],

4113+above.) For DZSlides, the (relatively short) JavaScript and CSS are included in

4114+the file by default.

4115+

4116+With all HTML slide formats, the `--self-contained` option can be used to

4117+produce a single file that contains all of the data necessary to display the

4118+slide show, including linked scripts, stylesheets, images, and videos.

57224119

57234120To produce a PDF slide show using beamer, type

57244121

@@ -5731,13 +4128,14 @@ To produce a Powerpoint slide show, type

57314128

57324129 pandoc habits.txt -o habits.pptx

57334130

5734−## Structuring the slide show

4131+Structuring the slide show

4132+--------------------------

57354133

5736−By default, the *slide level* is the highest heading level in

4134+By default, the *slide level* is the highest header level in

57374135the hierarchy that is followed immediately by content, and not another

5738−heading, somewhere in the document. In the example above, level-1 headings

5739−are always followed by level-2 headings, which are followed by content,

5740−so the slide level is 2. This default can be overridden using

4136+header, somewhere in the document. In the example above, level 1 headers

4137+are always followed by level 2 headers, which are followed by content,

4138+so 2 is the slide level. This default can be overridden using

57414139the `--slide-level` option.

57424140

57434141The document is carved up into slides according to the following

@@ -5745,21 +4143,17 @@ rules:

57454143

57464144 * A horizontal rule always starts a new slide.

57474145

5748− * A heading at the slide level always starts a new slide.

4146+ * A header at the slide level always starts a new slide.

57494147

5750− * Headings *below* the slide level in the hierarchy create

5751− headings *within* a slide. (In beamer, a "block" will be

5752− created. If the heading has the class `example`, an

5753− `exampleblock` environment will be used; if it has the class

5754− `alert`, an `alertblock` will be used; otherwise a regular

5755− `block` will be used.)

4148+ * Headers *below* the slide level in the hierarchy create

4149+ headers *within* a slide.

57564150

5757− * Headings *above* the slide level in the hierarchy create

4151+ * Headers *above* the slide level in the hierarchy create

57584152 "title slides," which just contain the section title

57594153 and help to break the slide show into sections.

5760− Non-slide content under these headings will be included

5761− on the title slide (for HTML slide shows) or in a

5762− subsequent slide with the same title (for beamer).

4154+

4155+ * Content *above* the slide level will not appear in the slide

4156+ show.

57634157

57644158 * A title page is constructed automatically from the document's title

57654159 block, if present. (In the case of beamer, this can be disabled

@@ -5767,57 +4161,32 @@ rules:

57674161

57684162These rules are designed to support many different styles of slide show. If

57694163you don't care about structuring your slides into sections and subsections,

5770−you can just use level-1 headings for all each slide. (In that case, level-1

4164+you can just use level 1 headers for all each slide. (In that case, level 1

57714165will be the slide level.) But you can also structure the slide show into

57724166sections, as in the example above.

57734167

57744168Note: in reveal.js slide shows, if slide level is 2, a two-dimensional

5775−layout will be produced, with level-1 headings building horizontally

5776−and level-2 headings building vertically. It is not recommended that

4169+layout will be produced, with level 1 headers building horizontally

4170+and level 2 headers building vertically. It is not recommended that

57774171you use deeper nesting of section levels with reveal.js.

57784172

5779−## Incremental lists

4173+Incremental lists

4174+-----------------

57804175

57814176By default, these writers produce lists that display "all at once."

57824177If you want your lists to display incrementally (one item at a time),

57834178use the `-i` option. If you want a particular list to depart from the

5784−default, put it in a `div` block with class `incremental` or

5785−`nonincremental`. So, for example, using the `fenced div` syntax, the

5786−following would be incremental regardless of the document default:

5787−

5788− ::: incremental

5789−

5790− - Eat spaghetti

5791− - Drink wine

5792−

5793− :::

5794−

5795−or

5796−

5797− ::: nonincremental

5798−

5799− - Eat spaghetti

5800− - Drink wine

5801−

5802− :::

5803−

5804−While using `incremental` and `nonincremental` divs are the

5805−recommended method of setting incremental lists on a per-case basis,

5806−an older method is also supported: putting lists inside a blockquote

5807−will depart from the document default (that is, it will display

5808−incrementally without the `-i` option and all at once with the `-i`

5809−option):

4179+default (that is, to display incrementally without the `-i` option and

4180+all at once with the `-i` option), put it in a block quote:

58104181

58114182 > - Eat spaghetti

58124183 > - Drink wine

58134184

5814−Both methods allow incremental and nonincremental lists to be mixed

5815−in a single document.

4185+In this way incremental and nonincremental lists can be mixed in

4186+a single document.

58164187

5817−Note: Neither the `-i/--incremental` option nor any of the

5818−methods described here currently works for PowerPoint output.

5819−

5820−## Inserting pauses

4188+Inserting pauses

4189+----------------

58214190

58224191You can add "pauses" within a slide by including a paragraph containing

58234192three dots, separated by spaces:

@@ -5830,9 +4199,8 @@ three dots, separated by spaces:

58304199

58314200 content after the pause

58324201

5833−Note: this feature is not yet implemented for PowerPoint output.

5834−

5835−## Styling the slides

4202+Styling the slides

4203+------------------

58364204

58374205You can change the style of HTML slides by putting customized CSS files

58384206in `$DATADIR/s5/default` (for S5), `$DATADIR/slidy` (for Slidy),

@@ -5857,9 +4225,9 @@ To style beamer slides, you can specify a `theme`, `colortheme`,

58574225

58584226 pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf

58594227

5860−Note that heading attributes will turn into slide attributes

4228+Note that header attributes will turn into slide attributes

58614229(on a `<div>` or `<section>`) in HTML slide formats, allowing you

5862−to style individual slides. In beamer, the only heading attribute

4230+to style individual slides. In beamer, the only header attribute

58634231that affects slides is the `allowframebreaks` class, which sets the

58644232`allowframebreaks` option, causing multiple slides to be created

58654233if the content overfills the frame. This is recommended especially for

@@ -5867,10 +4235,11 @@ bibliographies:

58674235

58684236 # References {.allowframebreaks}

58694237

5870−## Speaker notes

4238+Speaker notes

4239+-------------

58714240

5872−Speaker notes are supported in reveal.js and PowerPoint (pptx)

5873−output. You can add notes to your Markdown document thus:

4241+reveal.js has good support for speaker notes. You can add notes to your

4242+Markdown document thus:

58744243

58754244 ::: notes

58764245

@@ -5881,14 +4250,12 @@ output. You can add notes to your Markdown document thus:

58814250

58824251 :::

58834252

5884−To show the notes window in reveal.js, press `s` while viewing the

5885−presentation. Speaker notes in PowerPoint will be available, as usual,

5886−in handouts and presenter view.

5887−

4253+To show the notes window, press `s` while viewing the presentation.

58884254Notes are not yet supported for other slide formats, but the notes

58894255will not appear on the slides themselves.

58904256

5891−## Columns

4257+Columns

4258+-------

58924259

58934260To put material in side by side columns, you can use a native

58944261div container with class `columns`, containing two or more div

@@ -5903,46 +4270,12 @@ containers with class `column` and a `width` attribute:

59034270 :::

59044271 ::::::::::::::

59054272

5906−### Additional columns attributes in beamer

5907−

5908−The div containers with classes `columns` and `column` can optionally have

5909−an `align` attribute.

5910−The class `columns` can optionally have a `totalwidth` attribute or an

5911−`onlytextwidth` class.

5912−

5913− :::::::::::::: {.columns align=center totalwidth=8em}

5914− ::: {.column width="40%"}

5915− contents...

5916− :::

5917− ::: {.column width="60%" align=bottom}

5918− contents...

5919− :::

5920− ::::::::::::::

5921−

5922−The `align` attributes on `columns` and `column` can be used with the

5923−values `top`, `top-baseline`, `center` and `bottom` to vertically align

5924−the columns. It defaults to `top` in `columns`.

5925−

5926−The `totalwidth` attribute limits the width of the columns to the given value.

5927−

5928− :::::::::::::: {.columns align=top .onlytextwidth}

5929− ::: {.column width="40%" align=center}

5930− contents...

5931− :::

5932− ::: {.column width="60%"}

5933− contents...

5934− :::

5935− ::::::::::::::

5936−

5937−The class `onlytextwidth` sets the `totalwidth` to `\textwidth`.

5938−

5939−See Section 12.7 of the [Beamer User's Guide] for more details.

5940−

5941−## Frame attributes in beamer

4273+Frame attributes in beamer

4274+--------------------------

59424275

59434276Sometimes it is necessary to add the LaTeX `[fragile]` option to

59444277a frame in beamer (for example, when using the `minted` environment).

5945−This can be forced by adding the `fragile` class to the heading

4278+This can be forced by adding the `fragile` class to the header

59464279introducing the slide:

59474280

59484281 # Fragile slide {.fragile}

@@ -5950,64 +4283,13 @@ introducing the slide:

59504283All of the other frame attributes described in Section 8.1 of

59514284the [Beamer User's Guide] may also be used: `allowdisplaybreaks`,

59524285`allowframebreaks`, `b`, `c`, `t`, `environment`, `label`, `plain`,

5953−`shrink`, `standout`, `noframenumbering`.

5954−

5955−## Background in reveal.js and beamer

5956−

5957−Background images can be added to self-contained reveal.js slideshows and

5958−to beamer slideshows.

5959−

5960−For the same image on every slide, use the configuration

5961−option `background-image` either in the YAML metadata block

5962−or as a command-line variable. (There are no other options in

5963−beamer and the rest of this section concerns reveal.js slideshows.)

5964−

5965−For reveal.js, you can instead use the reveal.js-native option

5966−`parallaxBackgroundImage`. You can also set `parallaxBackgroundHorizontal`

5967−and `parallaxBackgroundVertical` the same way and must also set

5968−`parallaxBackgroundSize` to have your values take effect.

5969−

5970−To set an image for a particular reveal.js slide, add

5971−`{data-background-image="/path/to/image"}`

5972−to the first slide-level heading on the slide (which may even be empty).

5973−

5974−In reveal.js's overview mode, the parallaxBackgroundImage will show up

5975−only on the first slide.

5976−

5977−Other reveal.js background settings also work on individual slides, including

5978−`data-background-size`, `data-background-repeat`, `data-background-color`,

5979−`data-transition`, and `data-transition-speed`.

5980−

5981−To add a background image to the automatically generated title slide, use the

5982−`title-slide-attributes` variable in the YAML metadata block. It must contain

5983−a map of attribute names and values.

5984−

5985−See the [reveal.js documentation](https://revealjs.com/backgrounds/) for more

5986−details.

5987−

5988−For example in reveal.js:

5989−

5990−```

5991−---

5992−title: My Slideshow

5993−parallaxBackgroundImage: /path/to/my/background_image.png

5994−title-slide-attributes:

5995− data-background-image: /path/to/title_image.png

5996− data-background-size: contain

5997−---

5998−

5999−## Slide One

6000−

6001−Slide 1 has background_image.png as its background.

6002−

6003−## {data-background-image="/path/to/special_image.jpg"}

4286+`shrink`.

60044287

6005−Slide 2 has a special image for its background, even though the heading has no content.

6006−```

6007−

6008−# EPUBs

4288+Creating EPUBs with pandoc

4289+==========================

60094290

6010−## EPUB Metadata

4291+EPUB Metadata

4292+-------------

60114293

60124294EPUB metadata may be specified using the `--epub-metadata` option, but

60134295if the source document is Markdown, it is better to use a [YAML metadata

@@ -6085,20 +4367,11 @@ The following fields are recognized:

60854367

60864368`rights`

60874369 ~ A string value.

6088−

6089−`belongs-to-collection`

6090− ~ A string value. identifies the name of a collection to which

6091− the EPUB Publication belongs.

6092−

6093−`group-position`

6094− ~ The `group-position` field indicates the numeric position in which

6095− the EPUB Publication belongs relative to other works belonging to

6096− the same `belongs-to-collection` field.

60974370

60984371`cover-image`

60994372 ~ A string value (path to cover image).

61004373

6101−`css` (or legacy: `stylesheet`)

4374+`stylesheet`

61024375 ~ A string value (path to CSS stylesheet).

61034376

61044377`page-progression-direction`

@@ -6115,200 +4388,32 @@ The following fields are recognized:

61154388 - `binding`: `true`|`false` (default `true`)

61164389 - `scroll-axis`: `vertical`|`horizontal`|`default`

61174390

6118−[MARC relators]: https://loc.gov/marc/relators/relaterm.html

4391+[MARC relators]: http://loc.gov/marc/relators/relaterm.html

61194392[`spine` element]: http://idpf.org/epub/301/spec/epub-publications.html#sec-spine-elem

61204393

6121−## The `epub:type` attribute

6122−

6123−For `epub3` output, you can mark up the heading that corresponds to an EPUB

6124−chapter using the [`epub:type` attribute][epub-type]. For example, to set

6125−the attribute to the value `prologue`, use this markdown:

6126−

6127− # My chapter {epub:type=prologue}

6128−

6129−Which will result in:

6130−

6131− <body epub:type="frontmatter">

6132− <section epub:type="prologue">

6133− <h1>My chapter</h1>

6134−

6135−Pandoc will output `<body epub:type="bodymatter">`, unless

6136−you use one of the following values, in which case either

6137−`frontmatter` or `backmatter` will be output.

6138−

6139−`epub:type` of first section `epub:type` of body

6140−---------------------------- ------------------

6141−prologue frontmatter

6142−abstract frontmatter

6143−acknowledgments frontmatter

6144−copyright-page frontmatter

6145−dedication frontmatter

6146−credits frontmatter

6147−keywords frontmatter

6148−imprint frontmatter

6149−contributors frontmatter

6150−other-credits frontmatter

6151−errata frontmatter

6152−revision-history frontmatter

6153−titlepage frontmatter

6154−halftitlepage frontmatter

6155−seriespage frontmatter

6156−foreword frontmatter

6157−preface frontmatter

6158−appendix backmatter

6159−colophon backmatter

6160−bibliography backmatter

6161−index backmatter

6162−

6163−[epub-type]: http://www.idpf.org/epub/31/spec/epub-contentdocs.html#sec-epub-type-attribute

6164−

6165−## Linked media

6166−

6167−By default, pandoc will download media referenced from any `<img>`, `<audio>`,

6168−`<video>` or `<source>` element present in the generated EPUB,

6169−and include it in the EPUB container, yielding a completely

4394+Linked media

4395+------------

4396+

4397+By default, pandoc will download linked media (including audio and

4398+video) and include it in the EPUB container, yielding a completely

61704399self-contained EPUB. If you want to link to external media resources

61714400instead, use raw HTML in your source and add `data-external="1"` to the tag

61724401with the `src` attribute. For example:

61734402

61744403 <audio controls="1">

6175− <source src="https://example.com/music/toccata.mp3"

4404+ <source src="http://example.com/music/toccata.mp3"

61764405 data-external="1" type="audio/mpeg">

61774406 </source>

61784407 </audio>

61794408

6180−# Jupyter notebooks

6181−

6182−When creating a [Jupyter notebook], pandoc will try to infer the

6183−notebook structure. Code blocks with the class `code` will be

6184−taken as code cells, and intervening content will be taken as

6185−Markdown cells. Attachments will automatically be created for

6186−images in Markdown cells. Metadata will be taken from the

6187−`jupyter` metadata field. For example:

6188−

6189−````

6190−---

6191−title: My notebook

6192−jupyter:

6193− nbformat: 4

6194− nbformat_minor: 5

6195− kernelspec:

6196− display_name: Python 2

6197− language: python

6198− name: python2

6199− language_info:

6200− codemirror_mode:

6201− name: ipython

6202− version: 2

6203− file_extension: ".py"

6204− mimetype: "text/x-python"

6205− name: "python"

6206− nbconvert_exporter: "python"

6207− pygments_lexer: "ipython2"

6208− version: "2.7.15"

6209−---

6210−

6211−# Lorem ipsum

6212−

6213−**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus

6214−bibendum felis dictum sodales.

6215−

6216−``` code

6217−print("hello")

6218−```

6219−

6220−## Pyout

6221−

6222−``` code

6223−from IPython.display import HTML

6224−HTML("""

6225−<script>

6226−console.log("hello");

6227−</script>

6228−<b>HTML</b>

6229−""")

6230−```

6231−

6232−## Image

6233−

6234−This image  will be

6235−included as a cell attachment.

6236−````

6237−

6238−If you want to add cell attributes, group cells differently, or

6239−add output to code cells, then you need to include divs to

6240−indicate the structure. You can use either [fenced

6241−divs][Extension: `fenced_divs`] or [native divs][Extension:

6242−`native_divs`] for this. Here is an example:

6243−

6244−````

6245−:::::: {.cell .markdown}

6246−# Lorem

6247−

6248−**Lorem ipsum** dolor sit amet, consectetur adipiscing elit. Nunc luctus

6249−bibendum felis dictum sodales.

6250−::::::

6251−

6252−:::::: {.cell .code execution_count=1}

6253−``` {.python}

6254−print("hello")

6255−```

6256−

6257−::: {.output .stream .stdout}

6258−```

6259−hello

6260−```

6261−:::

6262−::::::

6263−

6264−:::::: {.cell .code execution_count=2}

6265−``` {.python}

6266−from IPython.display import HTML

6267−HTML("""

6268−<script>

6269−console.log("hello");

6270−</script>

6271−<b>HTML</b>

6272−""")

6273−```

6274−

6275−::: {.output .execute_result execution_count=2}

6276−```{=html}

6277−<script>

6278−console.log("hello");

6279−</script>

6280−<b>HTML</b>

6281−hello

6282−```

6283−:::

6284−::::::

6285−````

6286−

6287−If you include raw HTML or TeX in an output cell, use the

6288−[raw attribute][Extension: `fenced_attribute`], as shown

6289−in the last cell of the example above. Although pandoc can

6290−process "bare" raw HTML and TeX, the result is often

6291−interspersed raw elements and normal textual elements, and

6292−in an output cell pandoc expects a single, connected raw

6293−block. To avoid using raw HTML or TeX except when

6294−marked explicitly using raw attributes, we recommend

6295−specifying the extensions `-raw_html-raw_tex+raw_attribute` when

6296−translating between Markdown and ipynb notebooks.

6297−

6298−Note that options and extensions that affect reading and

6299−writing of Markdown will also affect Markdown cells in ipynb

6300−notebooks. For example, `--wrap=preserve` will preserve

6301−soft line breaks in Markdown cells; `--atx-headers` will

6302−cause ATX-style headings to be used; and `--preserve-tabs` will

6303−prevent tabs from being turned to spaces.

6304−

6305−# Syntax highlighting

4409+Syntax highlighting

4410+===================

63064411

63074412Pandoc will automatically highlight syntax in [fenced code blocks] that

63084413are marked with a language name. The Haskell library [skylighting] is

6309−used for highlighting. Currently highlighting is supported only for

6310−HTML, EPUB, Docx, Ms, and LaTeX/PDF output. To see a list of language names

6311−that pandoc will recognize, type `pandoc --list-highlight-languages`.

4414+used for highlighting, which works in HTML, Docx, Ms, and LaTeX/PDF output.

4415+To see a list of language names that pandoc will recognize, type

4416+`pandoc --list-highlight-languages`.

63124417

63134418The color scheme can be selected using the `--highlight-style` option.

63144419The default color scheme is `pygments`, which imitates the default color

@@ -6316,36 +4421,15 @@ scheme used by the Python library pygments (though pygments is not actually

63164421used to do the highlighting). To see a list of highlight styles,

63174422type `pandoc --list-highlight-styles`.

63184423

6319−If you are not satisfied with the predefined styles, you can

6320−use `--print-highlight-style` to generate a JSON `.theme` file which

6321−can be modified and used as the argument to `--highlight-style`. To

6322−get a JSON version of the `pygments` style, for example:

6323−

6324− pandoc --print-highlight-style pygments > my.theme

6325−

6326−Then edit `my.theme` and use it like this:

6327−

6328− pandoc --highlight-style my.theme

6329−

6330−If you are not satisfied with the built-in highlighting, or you

6331−want highlight a language that isn't supported, you can use the

6332−`--syntax-definition` option to load a [KDE-style XML syntax definition

6333−file](https://docs.kde.org/stable5/en/kate/katepart/highlight.html).

6334−Before writing your own, have a look at KDE's [repository of syntax

6335−definitions](https://github.com/KDE/syntax-highlighting/tree/master/data/syntax).

6336−

63374424To disable highlighting, use the `--no-highlight` option.

63384425

63394426[skylighting]: https://github.com/jgm/skylighting

63404427

6341−# Custom Styles

6342−

6343−Custom styles can be used in the docx and ICML formats.

6344−

6345−## Output

4428+Custom Styles in Docx Output

4429+============================

63464430

6347−By default, pandoc's docx and ICML output applies a predefined set of styles

6348−for blocks such as paragraphs and block quotes, and uses largely default

4431+By default, pandoc's docx output applies a predefined set of styles for

4432+blocks such as paragraphs and block quotes, and uses largely default

63494433formatting (italics, bold) for inlines. This will work for most

63504434purposes, especially alongside a `reference.docx` file. However, if you

63514435need to apply your own styles to blocks, or match a preexisting set of

@@ -6353,10 +4437,8 @@ styles, pandoc allows you to define custom styles for blocks and text

63534437using `div`s and `span`s, respectively.

63544438

63554439If you define a `div` or `span` with the attribute `custom-style`,

6356−pandoc will apply your specified style to the contained elements (with

6357−the exception of elements whose function depends on a style, like

6358−headings, code blocks, block quotes, or links). So, for example, using

6359−the `bracketed_spans` syntax,

4440+pandoc will apply your specified style to the contained elements. So,

4441+for example using the `bracketed_spans` syntax,

63604442

63614443 [Get out]{custom-style="Emphatically"}, he said.

63624444

@@ -6372,9 +4454,9 @@ style `Emphatically`. Similarly, using the `fenced_divs` syntax,

63724454

63734455would style the two contained lines with the `Poetry` paragraph style.

63744456

6375−For docx output, styles will be defined in the output file as inheriting

6376−from normal text, if the styles are not yet in your reference.docx.

6377−If they are already defined, pandoc will not alter the definition.

4457+If the styles are not yet in your reference.docx, they will be defined

4458+in the output file as inheriting from normal text. If they are already

4459+defined, pandoc will not alter the definition.

63784460

63794461This feature allows for greatest customization in conjunction with

63804462[pandoc filters]. If you want all paragraphs after block quotes to be

@@ -6384,137 +4466,34 @@ want all italics to be transformed to the `Emphasis` character style

63844466transform all italicized inlines to inlines within an `Emphasis`

63854467custom-style `span`.

63864468

6387−For docx output, you don't need to enable any extensions for

6388−custom styles to work.

6389−

6390−[pandoc filters]: https://pandoc.org/filters.html

6391−

6392−## Input

6393−

6394−The docx reader, by default, only reads those styles that it can

6395−convert into pandoc elements, either by direct conversion or

6396−interpreting the derivation of the input document's styles.

6397−

6398−By enabling the [`styles` extension](#ext-styles) in the docx reader

6399−(`-f docx+styles`), you can produce output that maintains the styles

6400−of the input document, using the `custom-style` class. Paragraph

6401−styles are interpreted as divs, while character styles are interpreted

6402−as spans.

4469+[pandoc filters]: http://pandoc.org/filters.html

64034470

6404−For example, using the `custom-style-reference.docx` file in the test

6405−directory, we have the following different outputs:

4471+Custom writers

4472+==============

64064473

6407−Without the `+styles` extension:

4474+Pandoc can be extended with custom writers written in [lua]. (Pandoc

4475+includes a lua interpreter, so lua need not be installed separately.)

64084476

6409− $ pandoc test/docx/custom-style-reference.docx -f docx -t markdown

6410− This is some text.

6411−

6412− This is text with an *emphasized* text style. And this is text with a

6413− **strengthened** text style.

6414−

6415− > Here is a styled paragraph that inherits from Block Text.

6416−

6417−And with the extension:

6418−

6419− $ pandoc test/docx/custom-style-reference.docx -f docx+styles -t markdown

6420−

6421− ::: {custom-style="First Paragraph"}

6422− This is some text.

6423− :::

6424−

6425− ::: {custom-style="Body Text"}

6426− This is text with an [emphasized]{custom-style="Emphatic"} text style.

6427− And this is text with a [strengthened]{custom-style="Strengthened"}

6428− text style.

6429− :::

6430−

6431− ::: {custom-style="My Block Style"}

6432− > Here is a styled paragraph that inherits from Block Text.

6433− :::

6434−

6435−With these custom styles, you can use your input document as a

6436−reference-doc while creating docx output (see below), and maintain the

6437−same styles in your input and output files.

6438−

6439−# Custom writers

6440−

6441−Pandoc can be extended with custom writers written in [Lua]. (Pandoc

6442−includes a Lua interpreter, so Lua need not be installed separately.)

6443−

6444−To use a custom writer, simply specify the path to the Lua script

4477+To use a custom writer, simply specify the path to the lua script

64454478in place of the output format. For example:

64464479

64474480 pandoc -t data/sample.lua

64484481

6449−Creating a custom writer requires writing a Lua function for each

4482+Creating a custom writer requires writing a lua function for each

64504483possible element in a pandoc document. To get a documented example

64514484which you can modify according to your needs, do

64524485

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

64544487

6455−Note that custom writers have no default template. If you want

6456−to use `--standalone` with a custom writer, you will need to

6457−specify a template manually using `--template` or add a new

6458−default template with the name

6459−`default.NAME_OF_CUSTOM_WRITER.lua` to the `templates`

6460−subdirectory of your user data directory (see [Templates]).

6461−

6462−[Lua]: https://www.lua.org

6463−

6464−# Reproducible builds

6465−

6466−Some of the document formats pandoc targets (such as EPUB,

6467−docx, and ODT) include build timestamps in the generated document.

6468−That means that the files generated on successive builds will

6469−differ, even if the source does not. To avoid this, set the

6470−`SOURCE_DATE_EPOCH` environment variable, and the timestamp will

6471−be taken from it instead of the current time.

6472−`SOURCE_DATE_EPOCH` should contain an integer unix timestamp

6473−(specifying the number of second since midnight UTC January 1, 1970).

6474−

6475−Some document formats also include a unique identifier. For

6476−EPUB, this can be set explicitly by setting the `identifier`

6477−metadata field (see [EPUB Metadata], above).

6478−

6479−# A note on security

6480−

6481−If you use pandoc to convert user-contributed content in a web

6482−application, here are some things to keep in mind:

6483−

6484−1. Although pandoc itself will not create or modify any files other

6485− than those you explicitly ask it create (with the exception

6486− of temporary files used in producing PDFs), a filter or custom

6487− writer could in principle do anything on your file system. Please

6488− audit filters and custom writers very carefully before using them.

6489−

6490−2. If your application uses pandoc as a Haskell library (rather than

6491− shelling out to the executable), it is possible to use it in a mode

6492− that fully isolates pandoc from your file system, by running the

6493− pandoc operations in the `PandocPure` monad. See the document

6494− [Using the pandoc API](https://pandoc.org/using-the-pandoc-api.html)

6495− for more details.

6496−

6497−3. Pandoc's parsers can exhibit pathological performance on some

6498− corner cases. It is wise to put any pandoc operations under

6499− a timeout, to avoid DOS attacks that exploit these issues.

6500− If you are using the pandoc executable, you can add the

6501− command line options `+RTS -M512M -RTS` (for example) to limit

6502− the heap size to 512MB.

6503−

6504−4. The HTML generated by pandoc is not guaranteed to be safe.

6505− If `raw_html` is enabled for the Markdown input, users can

6506− inject arbitrary HTML. Even if `raw_html` is disabled,

6507− users can include dangerous content in URLs and attributes.

6508− To be safe, you should run all the generated HTML through

6509− an HTML sanitizer.

6510−

6511−# Authors

6512−

6513−Copyright 2006--2021 John MacFarlane (jgm@berkeley.edu). Released

4488+[lua]: http://www.lua.org

4489+

4490+Authors

4491+=======

4492+

4493+Copyright 2006-2017 John MacFarlane (jgm@berkeley.edu). Released

65144494under the [GPL], version 2 or greater. This software carries no

65154495warranty of any kind. (See COPYRIGHT for full copyright and

65164496warranty notices.) For a full list of contributors, see the file

65174497AUTHORS.md in the pandoc source code.

65184498

6519−[GPL]: https://www.gnu.org/copyleft/gpl.html "GNU General Public License"

6520−[YAML]: https://yaml.org/spec/1.2/spec.html "YAML v1.2 Spec"

4499+[GPL]: http://www.gnu.org/copyleft/gpl.html "GNU General Public License"

Makefile+52−92

@@ -1,79 +1,39 @@

11version?=$(shell grep '^[Vv]ersion:' pandoc.cabal | awk '{print $$2;}')

22pandoc=$(shell find dist -name pandoc -type f -exec ls -t {} \; | head -1)

3−SOURCEFILES?=$(shell git ls-tree -r master --name-only | grep "\.hs$$")

3+SOURCEFILES?=$(shell find pandoc.hs src test -name '*.hs')

44BRANCH?=master

5−ARCH=$(shell uname -m)

6−DOCKERIMAGE=registry.gitlab.b-data.ch/ghc/ghc4pandoc:8.10.4

7−COMMIT=$(shell git rev-parse --short HEAD)

8−TIMESTAMP=$(shell date "+%Y%m%d_%H%M")

9−LATESTBENCH=$(word 1,$(shell ls -t bench_*.csv 2>/dev/null))

10−BASELINE?=$(LATESTBENCH)

11−ifeq ($(BASELINE),)

12−BASELINECMD=

13−else

14−BASELINECMD=--baseline $(BASELINE)

15−endif

16−GHCOPTS=-fdiagnostics-color=always -j4 +RTS -A8m -RTS

5+RESOLVER=lts-10

6+GHCOPTS=-fdiagnostics-color=always -Wall -fno-warn-unused-do-bind -Wincomplete-record-updates -Wnoncanonical-monad-instances -Wnoncanonical-monadfail-instances

177WEBSITE=../../web/pandoc.org

18−REVISION?=1

19−# For gauge:

20−# BENCHARGS?=--small --ci=0.90 --match=pattern $(PATTERN)

21−# For tasty-bench:

22−BENCHARGS?=--csv bench_$(TIMESTAMP).csv $(BASELINECMD) --timeout=6 +RTS -T -RTS $(if $(PATTERN),--pattern "$(PATTERN)",)

238

249quick:

25− stack install --ghc-options='$(GHCOPTS)' --install-ghc --flag 'pandoc:embed_data_files' --fast --test --ghc-options='$(GHCOPTS)' --test-arguments='-j4 --hide-successes $(TESTARGS)'

26−

27−quick-cabal:

28− cabal new-configure . --ghc-options '$(GHCOPTS)' --disable-optimization --enable-tests

29− cabal new-build -j4 . --disable-optimization

30− cabal new-run test-pandoc --disable-optimization -- --hide-successes $(TESTARGS)

31−

32−full-cabal:

33− cabal new-configure . --ghc-options '$(GHCOPTS)' --flags '+embed_data_files +trypandoc' --enable-tests --enable-benchmarks

34− cabal new-build . --disable-optimization

35− cabal new-run test-pandoc --disable-optimization -- --hide-successes $(TESTARGS)

10+ stack install --resolver=$(RESOLVER) --ghc-options='$(GHCOPTS)' --install-ghc --flag 'pandoc:embed_data_files' --fast --test --test-arguments='-j4 --hide-successes $(TESTARGS)'

3611

3712full:

38− stack install --flag 'pandoc:embed_data_files' --flag 'pandoc:trypandoc' --bench --no-run-benchmarks --test --test-arguments='-j4 --hide-successes' --ghc-options '-Wall -Werror -fno-warn-unused-do-bind -O0 $(GHCOPTS)'

39−

40−ghci:

41− stack ghci --flag 'pandoc:embed_data_files'

13+ stack install --resolver=$(RESOLVER) --flag 'pandoc:embed_data_files' --flag 'pandoc:weigh-pandoc' --flag 'pandoc:trypandoc' --bench --no-run-benchmarks --test --test-arguments='-j4 --hide-successes' --ghc-options '-Wall -Werror -fno-warn-unused-do-bind -O0 -j4 $(GHCOPTS)'

4214

4315haddock:

44− stack haddock

16+ stack haddock --resolver=$(RESOLVER)

4517

4618# Note: to accept current results of golden tests,

4719# make test TESTARGS='--accept'

4820test:

49− stack test --flag 'pandoc:embed_data_files' --fast --test-arguments='-j4 --hide-successes $(TESTARGS)' --ghc-options '$(GHCOPTS)'

50−

51−ghcid:

52− ghcid -c "stack repl --flag 'pandoc:embed_data_files'"

53−

54−ghcid-test:

55− ghcid -c "stack repl --ghc-options=-XNoImplicitPrelude --flag 'pandoc:embed_data_files' --ghci-options=-fobject-code pandoc:lib pandoc:test-pandoc"

21+ stack test --resolver=$(RESOLVER) --flag 'pandoc:embed_data_files' --fast --test-arguments='-j4 --hide-successes $(TESTARGS)' --ghc-options '$(GHCOPTS)'

5622

5723bench:

58− stack bench \

59− --ghc-options '$(GHCOPTS)' \

60− --benchmark-arguments='$(BENCHARGS)' 2>&1 | \

61− tee "bench_latest.txt"

24+ stack bench --benchmark-arguments='$(BENCHARGS)' --resolver=$(RESOLVER) --ghc-options '$(GHCOPTS)'

25+

26+weigh:

27+ stack build --resolver=$(RESOLVER) --ghc-options '$(GHCOPTS)' --flag 'pandoc:weigh-pandoc' && stack exec weigh-pandoc

6228

6329reformat:

6430 for f in $(SOURCEFILES); do echo $$f; stylish-haskell -i $$f ; done

6531

66−lint: hlint fix_spacing

67−

68−hlint:

69− for f in $(SOURCEFILES); do echo $$f; hlint --verbose --refactor --refactor-options='-s -o -' $$f; done

70−

71−fix_spacing:

72− # Fix trailing newlines and spaces at ends of lines

73− for f in $(SOURCEFILES); do printf '%s\n' "`cat $$f`" | sed -e 's/ *$$//' > $$f.tmp; mv $$f.tmp $$f; done

32+lint:

33+ for f in $(SOURCEFILES); do echo $$f; hlint --verbose --refactor --refactor-options='-i -s' $$f; done

7434

7535changes_github:

76− pandoc --filter tools/extract-changes.hs changelog.md -t gfm --wrap=none --template tools/changes_template.html | sed -e 's/\\#/#/g' | pbcopy

36+ pandoc --filter tools/extract-changes.hs changelog -t gfm --wrap=none | sed -e 's/\\#/#/g' | pbcopy

7737

7838dist: man/pandoc.1

7939 cabal sdist

@@ -82,35 +42,45 @@ dist: man/pandoc.1

8242 cd pandoc-${version}

8343 stack setup && stack test && cd .. && rm -rf "pandoc-${version}"

8444

85−check: checkdocs check-cabal

86−

87−checkdocs:

88− ! grep -q -n -e "\t" MANUAL.txt changelog.md

45+packages: winpkg debpkg macospkg

8946

9047debpkg: man/pandoc.1

91− docker run -v `pwd`:/mnt \

92− -v `pwd`/linux/artifacts:/artifacts \

93− --user $(id -u):$(id -g) \

94− -e REVISION=$(REVISION) \

95− -w /mnt \

96− --memory=0 \

97− --rm \

98− $(DOCKERIMAGE) \

99− bash \

100− /mnt/linux/make_artifacts.sh 2>&1 > docker.log

101−

102−man/pandoc.1: MANUAL.txt man/pandoc.1.before man/pandoc.1.after

103− pandoc $< -f markdown -t man -s \

48+ make -C linux && \

49+ cp linux/artifacts/pandoc-$(version)-*.* .

50+

51+macospkg: man/pandoc.1

52+ ./macos/make_macos_package.sh

53+

54+winpkg: pandoc-$(version)-windows.msi pandoc-$(version)-windows.zip

55+

56+pandoc-$(version)-windows.zip: pandoc-$(version)-windows.msi

57+ -rm -rf wintmp && \

58+ msiextract -C wintmp $< && \

59+ cd wintmp/"Program Files" && \

60+ mv Pandoc pandoc-$(version) && \

61+ zip -r $@ pandoc-$(version) && \

62+ mv $@ ../../ && \

63+ cd ../.. && \

64+ rm -rf wintmp

65+

66+pandoc-$(version)-windows.msi:

67+ wget 'https://ci.appveyor.com/api/projects/jgm/pandoc/artifacts/windows/pandoc-windows-i386.msi?branch=$(BRANCH)' -O pandoc.msi && \

68+ osslsigncode sign -pkcs12 ~/Private/ComodoCodeSigning.exp2019.p12 -in pandoc.msi -i http://johnmacfarlane.net/ -t http://timestamp.comodoca.com/ -out $@ -askpass

69+ rm pandoc.msi

70+

71+man/pandoc.1: MANUAL.txt man/pandoc.1.template

72+ pandoc $< -f markdown-smart -t man -s --template man/pandoc.1.template \

10473 --lua-filter man/manfilter.lua \

105− --include-before-body man/pandoc.1.before \

106− --include-after-body man/pandoc.1.after \

107− --metadata author="" \

108− --variable footer="pandoc $(version)" \

74+ --variable version="pandoc $(version)" \

10975 -o $@

11076

111−README.md: README.template MANUAL.txt tools/update-readme.lua

112− pandoc --lua-filter tools/update-readme.lua \

113− --reference-location=section -t gfm $< -o $@

77+doc/lua-filters.md: tools/ldoc.ltp data/pandoc.lua tools/update-lua-docs.lua

78+ cp $@ $@.tmp

79+ pandoc -t markdown --columns=64 --atx-headers \

80+ -f markdown -t markdown --standalone\

81+ --lua-filter tools/update-lua-docs.lua \

82+ -o $@ $@.tmp

83+ rm $@.tmp

11484

11585download_stats:

11686 curl https://api.github.com/repos/jgm/pandoc/releases | \

@@ -118,14 +88,14 @@ download_stats:

11888

11989pandoc-templates:

12090 rm ../pandoc-templates/default.* ; \

121− cp data/templates/* ../pandoc-templates/ ; \

91+ cp data/templates/default.* ../pandoc-templates/ ; \

12292 pushd ../pandoc-templates/ && \

123− git add * && \

93+ git add default.* && \

12494 git commit -m "Updated templates for pandoc $(version)" && \

12595 popd

12696

12797trypandoc:

128− ssh -t macfarlane 'cd src/pandoc && git pull && stack install --flag pandoc:trypandoc --flag pandoc:embed_data_files && cd trypandoc && sudo make install'

98+ ssh -t macfarlane 'cd src/pandoc && git pull && ~/.local/bin/stack install --flag pandoc:trypandoc --flag pandoc:embed_data_files && cd trypandoc && sudo make install'

12999

130100update-website:

131101 make -C $(WEBSITE) update

@@ -135,14 +105,4 @@ update-website:

135105clean:

136106 stack clean

137107

138−check-cabal: git-files.txt sdist-files.txt

139− echo "Checking to see if all committed test/data files are in sdist."

140− diff -u $^

141−

142−sdist-files.txt: .FORCE

143− cabal sdist --list-only | sed 's/\.\///' | grep '^\(test\|data\)\/' | sort > $@

144−

145−git-files.txt: .FORCE

146− git ls-tree -r --name-only HEAD | grep '^\(test\|data\)\/' | sort > $@

147−

148−.PHONY: .FORCE deps quick full haddock install clean test bench changes_github dist prof download_stats reformat lint weigh doc/lua-filters.md pandoc-templates trypandoc update-website debpkg checkdocs ghcid ghci fix_spacing hlint check check-cabal

108+.PHONY: deps quick full haddock install clean test bench changes_github macospkg dist prof download_stats reformat lint weigh doc/lua-filters.md packages pandoc-templates trypandoc update-website

README.md+148−237

@@ -1,244 +1,155 @@

1−<!-- Do not edit this file. It is generated automatically from

2−README.template and MANUAL.txt via the command:

3−pandoc --lua-filter tools/update-readme.lua README.template -o README.md

4−-->

5−

6−# Pandoc

7−

8−[![github

9−release](https://img.shields.io/github/release/jgm/pandoc.svg?label=current+release)](https://github.com/jgm/pandoc/releases)

10−[![hackage

11−release](https://img.shields.io/hackage/v/pandoc.svg?label=hackage)](https://hackage.haskell.org/package/pandoc)

12−[](https://formulae.brew.sh/formula/pandoc)

13−[![stackage LTS

14−package](https://stackage.org/package/pandoc/badge/lts)](https://www.stackage.org/lts/package/pandoc-types)

15−[![CI

16−tests](https://github.com/jgm/pandoc/workflows/CI%20tests/badge.svg)](https://github.com/jgm/pandoc/actions)

1+Pandoc

2+======

3+

4+[](https://github.com/jgm/pandoc/releases)

5+[](http://hackage.haskell.org/package/pandoc)

6+[](http://brewformulas.org/Pandoc)

7+[](http://stackage.org/lts/package/pandoc)

8+[](https://travis-ci.org/jgm/pandoc)

9+[](https://ci.appveyor.com/project/jgm/pandoc)

1710[](https://www.gnu.org/licenses/gpl.html)

18−[![pandoc-discuss on google

19−groups](https://img.shields.io/badge/pandoc-discuss-red.svg?style=social)](https://groups.google.com/forum/#!forum/pandoc-discuss)

20−

21−## The universal markup converter

22−

23−Pandoc is a [Haskell](https://haskell.org) library for converting from

24−one markup format to another, and a command-line tool that uses this

25−library. It can convert *from*

26−

27−<div id="input-formats">

28−

29−- `bibtex` ([BibTeX](https://ctan.org/pkg/bibtex) bibliography)

30−- `biblatex` ([BibLaTeX](https://ctan.org/pkg/biblatex) bibliography)

31−- `commonmark` ([CommonMark](https://commonmark.org) Markdown)

32−- `commonmark_x` ([CommonMark](https://commonmark.org) Markdown with

33− extensions)

34−- `creole` ([Creole 1.0](http://www.wikicreole.org/wiki/Creole1.0))

35−- `csljson` ([CSL

36− JSON](https://citeproc-js.readthedocs.io/en/latest/csl-json/markup.html)

37− bibliography)

38−- `csv` ([CSV](https://tools.ietf.org/html/rfc4180) table)

39−- `docbook` ([DocBook](https://docbook.org))

40−- `docx` ([Word docx](https://en.wikipedia.org/wiki/Office_Open_XML))

41−- `dokuwiki` ([DokuWiki markup](https://www.dokuwiki.org/dokuwiki))

42−- `epub` ([EPUB](http://idpf.org/epub))

43−- `fb2`

44− ([FictionBook2](http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1)

45− e-book)

46−- `gfm` ([GitHub-Flavored

47− Markdown](https://help.github.com/articles/github-flavored-markdown/)),

48− or the deprecated and less accurate `markdown_github`; use

49− [`markdown_github`](https://pandoc.org/MANUAL.html#markdown-variants)

50− only if you need extensions not supported in

51− [`gfm`](https://pandoc.org/MANUAL.html#markdown-variants).

52−- `haddock` ([Haddock

53− markup](https://www.haskell.org/haddock/doc/html/ch03s08.html))

54−- `html` ([HTML](https://www.w3.org/html/))

55−- `ipynb` ([Jupyter

56− notebook](https://nbformat.readthedocs.io/en/latest/))

57−- `jats` ([JATS](https://jats.nlm.nih.gov) XML)

58−- `jira`

59− ([Jira](https://jira.atlassian.com/secure/WikiRendererHelpAction.jspa?section=all)/Confluence

60− wiki markup)

61−- `json` (JSON version of native AST)

62−- `latex` ([LaTeX](https://www.latex-project.org/))

63−- `markdown` ([Pandoc’s

64− Markdown](https://pandoc.org/MANUAL.html#pandocs-markdown))

65−- `markdown_mmd`

66− ([MultiMarkdown](https://fletcherpenney.net/multimarkdown/))

67−- `markdown_phpextra` ([PHP Markdown

68− Extra](https://michelf.ca/projects/php-markdown/extra/))

69−- `markdown_strict` (original unextended

70− [Markdown](https://daringfireball.net/projects/markdown/))

71−- `mediawiki` ([MediaWiki

72− markup](https://www.mediawiki.org/wiki/Help:Formatting))

73−- `man` ([roff man](https://man.cx/groff_man(7)))

74−- `muse` ([Muse](https://amusewiki.org/library/manual))

75−- `native` (native Haskell)

76−- `odt` ([ODT](https://en.wikipedia.org/wiki/OpenDocument))

77−- `opml` ([OPML](http://dev.opml.org/spec2.html))

78−- `org` ([Emacs Org mode](https://orgmode.org))

79−- `rst`

80− ([reStructuredText](https://docutils.sourceforge.io/docs/ref/rst/introduction.html))

81−- `t2t` ([txt2tags](https://txt2tags.org))

82−- `textile` ([Textile](https://www.promptworks.com/textile))

83−- `tikiwiki` ([TikiWiki

84− markup](https://doc.tiki.org/Wiki-Syntax-Text#The_Markup_Language_Wiki-Syntax))

85−- `twiki` ([TWiki

86− markup](https://twiki.org/cgi-bin/view/TWiki/TextFormattingRules))

87−- `vimwiki` ([Vimwiki](https://vimwiki.github.io))

88−

89−</div>

90−

91−It can convert *to*

92−

93−<div id="output-formats">

94−

95−- `asciidoc` ([AsciiDoc](https://www.methods.co.nz/asciidoc/)) or

96− `asciidoctor` ([AsciiDoctor](https://asciidoctor.org/))

97−- `beamer` ([LaTeX beamer](https://ctan.org/pkg/beamer) slide show)

98−- `bibtex` ([BibTeX](https://ctan.org/pkg/bibtex) bibliography)

99−- `biblatex` ([BibLaTeX](https://ctan.org/pkg/biblatex) bibliography)

100−- `commonmark` ([CommonMark](https://commonmark.org) Markdown)

101−- `commonmark_x` ([CommonMark](https://commonmark.org) Markdown with

102− extensions)

103−- `context` ([ConTeXt](https://www.contextgarden.net/))

104−- `csljson` ([CSL

105− JSON](https://citeproc-js.readthedocs.io/en/latest/csl-json/markup.html)

106− bibliography)

107−- `docbook` or `docbook4` ([DocBook](https://docbook.org) 4)

108−- `docbook5` (DocBook 5)

109−- `docx` ([Word docx](https://en.wikipedia.org/wiki/Office_Open_XML))

110−- `dokuwiki` ([DokuWiki markup](https://www.dokuwiki.org/dokuwiki))

111−- `epub` or `epub3` ([EPUB](http://idpf.org/epub) v3 book)

112−- `epub2` (EPUB v2)

113−- `fb2`

114− ([FictionBook2](http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1)

115− e-book)

116−- `gfm` ([GitHub-Flavored

117− Markdown](https://help.github.com/articles/github-flavored-markdown/)),

118− or the deprecated and less accurate `markdown_github`; use

119− [`markdown_github`](https://pandoc.org/MANUAL.html#markdown-variants)

120− only if you need extensions not supported in

121− [`gfm`](https://pandoc.org/MANUAL.html#markdown-variants).

122−- `haddock` ([Haddock

123− markup](https://www.haskell.org/haddock/doc/html/ch03s08.html))

124−- `html` or `html5` ([HTML](https://www.w3.org/html/),

125− i.e. [HTML5](https://html.spec.whatwg.org/)/XHTML [polyglot

126− markup](https://www.w3.org/TR/html-polyglot/))

127−- `html4` ([XHTML](https://www.w3.org/TR/xhtml1/) 1.0 Transitional)

128−- `icml` ([InDesign

129− ICML](https://wwwimages.adobe.com/www.adobe.com/content/dam/acom/en/devnet/indesign/sdk/cs6/idml/idml-cookbook.pdf))

130−- `ipynb` ([Jupyter

131− notebook](https://nbformat.readthedocs.io/en/latest/))

132−- `jats_archiving` ([JATS](https://jats.nlm.nih.gov) XML, Archiving

133− and Interchange Tag Set)

134−- `jats_articleauthoring` ([JATS](https://jats.nlm.nih.gov) XML,

135− Article Authoring Tag Set)

136−- `jats_publishing` ([JATS](https://jats.nlm.nih.gov) XML, Journal

137− Publishing Tag Set)

138−- `jats` (alias for `jats_archiving`)

139−- `jira`

140− ([Jira](https://jira.atlassian.com/secure/WikiRendererHelpAction.jspa?section=all)/Confluence

141− wiki markup)

142−- `json` (JSON version of native AST)

143−- `latex` ([LaTeX](https://www.latex-project.org/))

144−- `man` ([roff man](https://man.cx/groff_man(7)))

145−- `markdown` ([Pandoc’s

146− Markdown](https://pandoc.org/MANUAL.html#pandocs-markdown))

147−- `markdown_mmd`

148− ([MultiMarkdown](https://fletcherpenney.net/multimarkdown/))

149−- `markdown_phpextra` ([PHP Markdown

150− Extra](https://michelf.ca/projects/php-markdown/extra/))

151−- `markdown_strict` (original unextended

152− [Markdown](https://daringfireball.net/projects/markdown/))

153−- `mediawiki` ([MediaWiki

154− markup](https://www.mediawiki.org/wiki/Help:Formatting))

155−- `ms` ([roff ms](https://man.cx/groff_ms(7)))

156−- `muse` ([Muse](https://amusewiki.org/library/manual)),

157−- `native` (native Haskell),

158−- `odt` ([OpenOffice text

159− document](https://en.wikipedia.org/wiki/OpenDocument))

160−- `opml` ([OPML](http://dev.opml.org/spec2.html))

161−- `opendocument` ([OpenDocument](http://opendocument.xml.org))

162−- `org` ([Emacs Org mode](https://orgmode.org))

163−- `pdf` ([PDF](https://www.adobe.com/pdf/))

164−- `plain` (plain text),

165−- `pptx`

166− ([PowerPoint](https://en.wikipedia.org/wiki/Microsoft_PowerPoint)

167− slide show)

168−- `rst`

169− ([reStructuredText](https://docutils.sourceforge.io/docs/ref/rst/introduction.html))

170−- `rtf` ([Rich Text

171− Format](https://en.wikipedia.org/wiki/Rich_Text_Format))

172−- `texinfo` ([GNU Texinfo](https://www.gnu.org/software/texinfo/))

173−- `textile` ([Textile](https://www.promptworks.com/textile))

174−- `slideous` ([Slideous](https://goessner.net/articles/slideous/) HTML

175− and JavaScript slide show)

176−- `slidy` ([Slidy](https://www.w3.org/Talks/Tools/Slidy2/) HTML and

177− JavaScript slide show)

178−- `dzslides` ([DZSlides](https://paulrouget.com/dzslides/) HTML5 +

179− JavaScript slide show),

180−- `revealjs` ([reveal.js](https://revealjs.com/) HTML5 + JavaScript

181− slide show)

182−- `s5` ([S5](https://meyerweb.com/eric/tools/s5/) HTML and JavaScript

183− slide show)

184−- `tei` ([TEI Simple](https://github.com/TEIC/TEI-Simple))

185−- `xwiki` ([XWiki

186− markup](https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/XWikiSyntax/))

187−- `zimwiki` ([ZimWiki

188− markup](https://zim-wiki.org/manual/Help/Wiki_Syntax.html))

189−- the path of a custom Lua writer, see [Custom

190− writers](https://pandoc.org/MANUAL.html#custom-writers) below

191−

192−</div>

193−

194−Pandoc can also produce PDF output via LaTeX, Groff ms, or HTML.

195−

196−Pandoc’s enhanced version of Markdown includes syntax for tables,

197−definition lists, metadata blocks, footnotes, citations, math, and much

198−more. See the User’s Manual below under [Pandoc’s

199−Markdown](https://pandoc.org/MANUAL.html#pandocs-markdown).

200−

201−Pandoc has a modular design: it consists of a set of readers, which

202−parse text in a given format and produce a native representation of the

203−document (an *abstract syntax tree* or AST), and a set of writers, which

204−convert this native representation into a target format. Thus, adding an

205−input or output format requires only adding a reader or writer. Users

206−can also run custom pandoc filters to modify the intermediate AST (see

207−the documentation for [filters](https://pandoc.org/filters.html) and

208−[Lua filters](https://pandoc.org/lua-filters.html)).

209−

210−Because pandoc’s intermediate representation of a document is less

211−expressive than many of the formats it converts between, one should not

212−expect perfect conversions between every format and every other. Pandoc

213−attempts to preserve the structural elements of a document, but not

214−formatting details such as margin size. And some document elements, such

215−as complex tables, may not fit into pandoc’s simple document model.

216−While conversions from pandoc’s Markdown to all formats aspire to be

217−perfect, conversions from formats more expressive than pandoc’s Markdown

218−can be expected to be lossy.

219−

220−## Installing

221−

222−Here’s [how to install pandoc](INSTALL.md).

223−

224−## Documentation

225−

226−Pandoc’s website contains a full [User’s

227−Guide](https://pandoc.org/MANUAL.html). It is also available

228−[here](MANUAL.txt) as pandoc-flavored Markdown. The website also

229−contains some [examples of the use of

11+[](https://groups.google.com/forum/#!forum/pandoc-discuss)

12+

13+

14+The universal markup converter

15+------------------------------

16+

17+Pandoc is a [Haskell] library for converting from one markup format to

18+another, and a command-line tool that uses this library. It can read

19+[Markdown], [CommonMark], [PHP Markdown Extra], [GitHub-Flavored

20+Markdown], [MultiMarkdown], and (subsets of) [Textile],

21+[reStructuredText], [HTML], [LaTeX], [MediaWiki markup], [TWiki markup],

22+[TikiWiki markup], [Creole 1.0], [Haddock markup], [OPML], [Emacs Org mode],

23+[DocBook], [JATS], [Muse], [txt2tags], [Vimwiki], [EPUB], [ODT], and

24+[Word docx]; and it can write plain text, [Markdown], [CommonMark], [PHP

25+Markdown Extra], [GitHub-Flavored Markdown], [MultiMarkdown],

26+[reStructuredText], [XHTML], [HTML5], [LaTeX] \(including

27+[`beamer`] slide shows\), [ConTeXt], [RTF], [OPML], [DocBook], [JATS],

28+[OpenDocument], [ODT], [Word docx], [GNU Texinfo], [MediaWiki

29+markup], [DokuWiki markup], [ZimWiki markup], [Haddock markup],

30+[EPUB] \(v2 or v3\), [FictionBook2], [Textile], [groff man],

31+[groff ms], [Emacs Org mode], [AsciiDoc], [InDesign ICML], [TEI

32+Simple], [Muse], [PowerPoint] slide shows and [Slidy], [Slideous],

33+[DZSlides], [reveal.js] or [S5] HTML slide shows. It can also produce

34+[PDF] output on systems where LaTeX, ConTeXt, `pdfroff`, `wkhtmltopdf`,

35+`prince`, or `weasyprint` is installed.

36+

37+Pandoc's enhanced version of Markdown includes syntax for [footnotes],

38+[tables], flexible [ordered lists], [definition lists], [fenced code

39+blocks], [superscripts and subscripts], [strikeout], [metadata blocks],

40+automatic tables of contents, embedded LaTeX [math], [citations], and

41+[Markdown inside HTML block elements](#extension-markdown_in_html_blocks).

42+(These enhancements, described further under

43+[Pandoc's Markdown], can be disabled using the `markdown_strict` input

44+or output format.)

45+

46+In contrast to most existing tools for converting Markdown to HTML, which

47+use regex substitutions, pandoc has a modular design: it consists of a

48+set of readers, which parse text in a given format and produce a native

49+representation of the document, and a set of writers, which convert

50+this native representation into a target format. Thus, adding an input

51+or output format requires only adding a reader or writer.

52+

53+Because pandoc's intermediate representation of a document is less

54+expressive than many of the formats it converts between, one should

55+not expect perfect conversions between every format and every other.

56+Pandoc attempts to preserve the structural elements of a document, but

57+not formatting details such as margin size. And some document elements,

58+such as complex tables, may not fit into pandoc's simple document

59+model. While conversions from pandoc's Markdown to all formats aspire

60+to be perfect, conversions from formats more expressive than pandoc's

61+Markdown can be expected to be lossy.

62+

63+[Markdown]: http://daringfireball.net/projects/markdown/

64+[CommonMark]: http://commonmark.org

65+[PHP Markdown Extra]: https://michelf.ca/projects/php-markdown/extra/

66+[GitHub-Flavored Markdown]: https://help.github.com/articles/github-flavored-markdown/

67+[MultiMarkdown]: http://fletcherpenney.net/multimarkdown/

68+[reStructuredText]: http://docutils.sourceforge.net/docs/ref/rst/introduction.html

69+[S5]: http://meyerweb.com/eric/tools/s5/

70+[Slidy]: http://www.w3.org/Talks/Tools/Slidy/

71+[Slideous]: http://goessner.net/articles/slideous/

72+[HTML]: http://www.w3.org/html/

73+[HTML5]: http://www.w3.org/TR/html5/

74+[XHTML]: http://www.w3.org/TR/xhtml1/

75+[LaTeX]: http://latex-project.org

76+[`beamer`]: https://ctan.org/pkg/beamer

77+[Beamer User's Guide]: http://ctan.math.utah.edu/ctan/tex-archive/macros/latex/contrib/beamer/doc/beameruserguide.pdf

78+[ConTeXt]: http://www.contextgarden.net/

79+[RTF]: http://en.wikipedia.org/wiki/Rich_Text_Format

80+[Creole 1.0]: http://www.wikicreole.org/wiki/Creole1.0

81+[DocBook]: http://docbook.org

82+[JATS]: https://jats.nlm.nih.gov

83+[txt2tags]: http://txt2tags.org

84+[EPUB]: http://idpf.org/epub

85+[OPML]: http://dev.opml.org/spec2.html

86+[OpenDocument]: http://opendocument.xml.org

87+[ODT]: http://en.wikipedia.org/wiki/OpenDocument

88+[Textile]: http://redcloth.org/textile

89+[MediaWiki markup]: https://www.mediawiki.org/wiki/Help:Formatting

90+[DokuWiki markup]: https://www.dokuwiki.org/dokuwiki

91+[ZimWiki markup]: http://zim-wiki.org/manual/Help/Wiki_Syntax.html

92+[TWiki markup]: http://twiki.org/cgi-bin/view/TWiki/TextFormattingRules

93+[Haddock markup]: https://www.haskell.org/haddock/doc/html/ch03s08.html

94+[groff man]: http://man7.org/linux/man-pages/man7/groff_man.7.html

95+[groff ms]: http://man7.org/linux/man-pages/man7/groff_ms.7.html

96+[Haskell]: https://www.haskell.org

97+[GNU Texinfo]: http://www.gnu.org/software/texinfo/

98+[Emacs Org mode]: http://orgmode.org

99+[AsciiDoc]: http://www.methods.co.nz/asciidoc/

100+[DZSlides]: http://paulrouget.com/dzslides/

101+[Word docx]: https://en.wikipedia.org/wiki/Office_Open_XML

102+[PDF]: https://www.adobe.com/pdf/

103+[reveal.js]: http://lab.hakim.se/reveal-js/

104+[FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1

105+[InDesign ICML]: https://www.adobe.com/content/dam/Adobe/en/devnet/indesign/cs55-docs/IDML/idml-specification.pdf

106+[TEI Simple]: https://github.com/TEIC/TEI-Simple

107+[Muse]: https://amusewiki.org/library/manual

108+[PowerPoint]: https://en.wikipedia.org/wiki/Microsoft_PowerPoint

109+[Vimwiki]: https://vimwiki.github.io

110+

111+

112+

113+[footnotes]: http://pandoc.org/MANUAL.html#footnotes

114+[tables]: http://pandoc.org/MANUAL.html#tables

115+[ordered lists]: http://pandoc.org/MANUAL.html#ordered-lists

116+[definition lists]: http://pandoc.org/MANUAL.html#definition-lists

117+[fenced code blocks]: http://pandoc.org/MANUAL.html#fenced-code-blocks

118+[superscripts and subscripts]: http://pandoc.org/MANUAL.html#superscripts-and-subscripts

119+[strikeout]: http://pandoc.org/MANUAL.html#strikeout

120+[metadata blocks]: http://pandoc.org/MANUAL.html#metadata-blocks

121+[math]: http://pandoc.org/MANUAL.html#math

122+[citations]: http://pandoc.org/MANUAL.html#citations

123+[Markdown inside HTML block elements]: http://pandoc.org/MANUAL.html#extension-markdown_in_html_blocks

124+[Pandoc's Markdown]: http://pandoc.org/MANUAL.html#pandocs-markdown

125+

126+Installing

127+----------

128+

129+Here's [how to install pandoc](INSTALL.md).

130+

131+Documentation

132+-------------

133+

134+Pandoc's website contains a full [User's Guide](https://pandoc.org/MANUAL.html).

135+It is also available [here](MANUAL.txt) as pandoc-flavored Markdown.

136+The website also contains some [examples of the use of

230137pandoc](https://pandoc.org/demos.html) and a limited [online

231138demo](https://pandoc.org/try).

232139

233−## Contributing

140+Contributing

141+------------

234142

235−Pull requests, bug reports, and feature requests are welcome. Please

236−make sure to read [the contributor guidelines](CONTRIBUTING.md) before

237−opening a new issue.

143+Pull requests, bug reports, and feature requests are welcome. Please make

144+sure to read [the contributor guidelines](CONTRIBUTING.md) before opening a

145+new issue.

238146

239−## License

240147

241−© 2006-2021 John MacFarlane (jgm@berkeley.edu). Released under the

242−[GPL](https://www.gnu.org/licenses/old-licenses/gpl-2.0.html "GNU General Public License"),

243−version 2 or greater. This software carries no warranty of any kind.

244−(See COPYRIGHT for full copyright and warranty notices.)

148+License

149+-------

150+

151+© 2006-2017 John MacFarlane (jgm@berkeley.edu). Released under the

152+[GPL], version 2 or greater. This software carries no warranty of

153+any kind. (See COPYRIGHT for full copyright and warranty notices.)

154+

155+[GPL]: http://www.gnu.org/copyleft/gpl.html "GNU General Public License"

README.templatedeleted−89

@@ -1,89 +0,0 @@

1−<!-- Do not edit this file. It is generated automatically from

2−README.template and MANUAL.txt via the command:

3−pandoc --lua-filter tools/update-readme.lua README.template -o README.md

4−-->

5−

6−Pandoc

7−======

8−

9−[](https://github.com/jgm/pandoc/releases)

10−[](https://hackage.haskell.org/package/pandoc)

11−[](https://formulae.brew.sh/formula/pandoc)

12−[](https://www.stackage.org/lts/package/pandoc-types)

13−[](https://github.com/jgm/pandoc/actions)

14−[](https://www.gnu.org/licenses/gpl.html)

15−[](https://groups.google.com/forum/#!forum/pandoc-discuss)

16−

17−

18−The universal markup converter

19−------------------------------

20−

21−Pandoc is a [Haskell] library for converting from one markup format to

22−another, and a command-line tool that uses this library. It can convert *from*

23−

24−::: {#input-formats}

25−:::

26−

27−It can convert *to*

28−

29−::: {#output-formats}

30−:::

31−

32−Pandoc can also produce PDF output via LaTeX, Groff ms, or HTML.

33−

34−Pandoc's enhanced version of Markdown includes syntax for tables,

35−definition lists, metadata blocks, footnotes, citations, math,

36−and much more. See the User's Manual below under

37−[Pandoc's Markdown](https://pandoc.org/MANUAL.html#pandocs-markdown).

38−

39−Pandoc has a modular design: it consists of a set of readers, which parse

40−text in a given format and produce a native representation of the document

41−(an _abstract syntax tree_ or AST), and a set of writers, which convert

42−this native representation into a target format. Thus, adding an input

43−or output format requires only adding a reader or writer. Users can also

44−run custom pandoc filters to modify the intermediate AST (see

45−the documentation for [filters](https://pandoc.org/filters.html)

46−and [Lua filters](https://pandoc.org/lua-filters.html)).

47−

48−Because pandoc's intermediate representation of a document is less

49−expressive than many of the formats it converts between, one should

50−not expect perfect conversions between every format and every other.

51−Pandoc attempts to preserve the structural elements of a document, but

52−not formatting details such as margin size. And some document elements,

53−such as complex tables, may not fit into pandoc's simple document

54−model. While conversions from pandoc's Markdown to all formats aspire

55−to be perfect, conversions from formats more expressive than pandoc's

56−Markdown can be expected to be lossy.

57−

58−

59−Installing

60−----------

61−

62−Here's [how to install pandoc](INSTALL.md).

63−

64−Documentation

65−-------------

66−

67−Pandoc's website contains a full [User's Guide](https://pandoc.org/MANUAL.html).

68−It is also available [here](MANUAL.txt) as pandoc-flavored Markdown.

69−The website also contains some [examples of the use of

70−pandoc](https://pandoc.org/demos.html) and a limited [online

71−demo](https://pandoc.org/try).

72−

73−Contributing

74−------------

75−

76−Pull requests, bug reports, and feature requests are welcome. Please make

77−sure to read [the contributor guidelines](CONTRIBUTING.md) before opening a

78−new issue.

79−

80−

81−License

82−-------

83−

84−© 2006-2021 John MacFarlane (jgm@berkeley.edu). Released under the

85−[GPL], version 2 or greater. This software carries no warranty of

86−any kind. (See COPYRIGHT for full copyright and warranty notices.)

87−

88−[GPL]: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html "GNU General Public License"

89−[Haskell]: https://haskell.org

RELEASE-CHECKLIST+33−20

@@ -1,21 +1,34 @@

1−[ ] use 'policeman' to check API changes and version update

2−[ ] make README.md and commit if needed

3−[ ] make man/pandoc.1 and commit if needed

4−[ ] Finalize changelog

5−[ ] push release candidate branch rc/VERSION and (if it builds

6− successfully) download artifacts

7−[ ] run tools/build-arm.sh to create and download arm64 linux package

8−[ ] download macos artifacts from CircleCI

9−[ ] Use 'make' in macos and windows artifacts to sign code

10−[ ] make update-website

11−[ ] make trypandoc

12−[ ] Tag release in git

13−[ ] make pandoc-templates

14− cd ../pandoc-templates

15− git tag REL

16− git push

17− git push --tags

18−[ ] Add release on github (use 'make changes_github' and upload files)

19−[ ] stack upload .

20−[ ] Announce on pandoc-announce, pandoc-discuss

1+_ Test, on Linux, Windows, macOS (inc. website demos)

2+

3+_ Finalize changelog

4+ git log --pretty='format:%n%n* %s (%an)%n%b%n%h%n' --reverse --name-only 1.17.0.3..HEAD > LOG

5+

6+_ make man/pandoc.1 and commit if needed

7+

8+_ Tag release in git

9+

10+_ make pandoc-templates

11+ cd ../pandoc-templates

12+ git tag REL

13+ git push

14+ git push --tags

15+

16+_ Generate Windows package (make winpkg)

17+

18+_ Generate macOS package (make macospkg)

19+

20+_ Generate Ubuntu/Debian deb package (make debpkg)

21+

22+- Add release on github (use 'make changes_github' and upload files)

23+

24+_ Upload to HackageDB: stack upload .

25+

26+_ if docs don't build on Hackage:

27+ 'cabal install neil && neil docs --username=MYUSERNAME'

28+

29+_ make update-website

30+

31+_ make trypandoc

32+

33+_ Announce on pandoc-announce, pandoc-discuss

2134

RELEASE-CHECKLIST.mdnew file+27

@@ -0,0 +1,27 @@

1+- [ ] Test, on Linux, Windows, macOS (inc. website demos)

2+

3+- [ ] Finalize changelog:

4+ `git log --pretty='format:%n%n* %s (%an)%n%b%n%h%n' --reverse --name-only 1.17.0.3..HEAD > LOG`

5+

6+- [ ] `make man/pandoc.1` and commit if needed

7+

8+- [ ] Tag release in git

9+

10+- [ ] Tag templates

11+

12+- [ ] Generate Windows package (`make winpkg`)

13+

14+- [ ] Generate macOS package (`make macospkg`)

15+

16+- [ ] Generate Ubuntu/Debian deb package (`make debpkg`)

17+

18+- [ ] Add release on github (use `make changes_github` and upload files)

19+

20+- [ ] Upload to HackageDB

21+

22+- [ ] Update website (`make update`), including short description of changes (`make changes`)

23+

24+- [ ] on server, `cabal install --enable-tests -ftrypandoc`

25+ and then `cd trypandoc; sudo make install`

26+

27+- [ ] Announce on pandoc-announce, pandoc-discuss

SECURITY.mddeleted−12

@@ -1,12 +0,0 @@

1−# Security Policy

2−

3−## Supported Versions

4−

5−Only the most recent version of pandoc is supported with security updates.

6−

7−## Reporting a Vulnerability

8−

9−To report a vulnerability, email the maintainer, jgm@berkeley.edu.

10−But first please read the section of the manual entitled

11−[A note on security](https://pandoc.org/MANUAL.html#a-note-on-security),

12−which describes some security guarantees pandoc does NOT make.

Setup.hs+37−1

@@ -1,2 +1,38 @@

1+{-

2+Copyright (C) 2006-2017 John MacFarlane <jgm@berkeley.edu>

3+

4+This program is free software; you can redistribute it and/or modify

5+it under the terms of the GNU General Public License as published by

6+the Free Software Foundation; either version 2 of the License, or

7+(at your option) any later version.

8+

9+This program is distributed in the hope that it will be useful,

10+but WITHOUT ANY WARRANTY; without even the implied warranty of

11+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

12+GNU General Public License for more details.

13+

14+You should have received a copy of the GNU General Public License

15+along with this program; if not, write to the Free Software

16+Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

17+-}

18+

119import Distribution.Simple

2−main = defaultMain

20+import Distribution.Simple.Setup (CopyFlags(..), fromFlag)

21+import Distribution.PackageDescription (PackageDescription(..))

22+import Distribution.Simple.Utils (notice, installOrdinaryFiles)

23+import Distribution.Simple.LocalBuildInfo

24+

25+main :: IO ()

26+main = defaultMainWithHooks $ simpleUserHooks {

27+ postCopy = installManPage

28+ }

29+

30+installManPage :: Args -> CopyFlags

31+ -> PackageDescription -> LocalBuildInfo -> IO ()

32+installManPage _ flags pkg lbi = do

33+ let verbosity = fromFlag (copyVerbosity flags)

34+ let copydest = fromFlag (copyDest flags)

35+ let mandest = mandir (absoluteInstallDirs pkg lbi copydest)

36+ ++ "/man1"

37+ notice verbosity $ "Copying man page to " ++ mandest

38+ installOrdinaryFiles verbosity mandest [("man", "pandoc.1")]

app/pandoc.hsdeleted−20

@@ -1,20 +0,0 @@

1−{- |

2− Module : Main

3− Copyright : Copyright (C) 2006-2021 John MacFarlane

4− License : GNU GPL, version 2 or above

5−

6− Maintainer : John MacFarlane <jgm@berkeley@edu>

7− Stability : alpha

8− Portability : portable

9−

10−Parses command-line options and calls the appropriate readers and

11−writers.

12−-}

13−module Main where

14−import qualified Control.Exception as E

15−import Text.Pandoc.App (convertWithOpts, defaultOpts, options, parseOptions)

16−import Text.Pandoc.Error (handleError)

17−

18−main :: IO ()

19−main = E.catch (parseOptions options defaultOpts >>= convertWithOpts)

20− (handleError . Left)

appveyor.ymlnew file+80

@@ -0,0 +1,80 @@

1+clone_folder: "c:\\pandoc"

2+environment:

3+ global:

4+ WIXBIN: "c:\\Program Files (x86)\\WiX Toolset v3.11\\bin"

5+ STACK_YAML: "c:\\pandoc\\stack.yaml"

6+ STACK_BUILD_OPTS: "-j1 --no-terminal --test --local-bin-path=.\\windows"

7+ matrix:

8+ - STACK_VERSION: "windows-i386"

9+ STACK_ROOT: "c:\\sr32"

10+ STACK: "%STACK_ROOT%\\stack.exe"

11+ STACK_FLAGS: "--flag=hslua:lua_32bits"

12+# - STACK_VERSION: "windows-x86_64"

13+# STACK_ROOT: "c:\\sr64"

14+# STACK: "%STACK_ROOT%\\stack.exe"

15+# STACK_FLAGS: ""

16+

17+skip_commits:

18+ files:

19+ - '*.md'

20+ - '*.txt'

21+ - '.travis.yml'

22+ - 'Makefile'

23+ - 'man/pandoc.1'

24+ - 'linux/*'

25+ - 'macos/*'

26+

27+matrix:

28+ fast_finish: true

29+

30+cache:

31+ - "%STACK_ROOT%"

32+ - "%WIXBIN%"

33+ # This is where stack install ghc by default, but we don't

34+ # cache it because it's too large:

35+ # - "c:\\Users\\appveyor\\AppData\\Local\\Programs\\stack"

36+

37+# Note: to reset build cache, do the following in JavaScript

38+# console on appveyor:

39+# $.ajax({

40+# url: 'https://ci.appveyor.com/api/projects/jgm/pandoc/buildcache',

41+# type: 'DELETE'})

42+

43+# We don't do a normal C build, but build in test_script via stack

44+build: off

45+

46+install:

47+ - '"%WIXBIN%"\candle -? || choco install wixtoolset'

48+ - |

49+ %STACK% --version || curl -ostack.zip -L --insecure http://www.stackage.org/stack/%STACK_VERSION% && 7z e stack.zip -o"%STACK_ROOT%" stack.exe

50+

51+# before_test:

52+

53+test_script:

54+ # The ugly echo "" hack is to avoid complaints about 0 being an invalid file

55+ # descriptor

56+ - |

57+ %STACK% setup > nul

58+ %STACK% path

59+ echo "" | %STACK% clean

60+ echo "" | %STACK% %STACK_BUILD_OPTS% install pandoc pandoc-citeproc %STACK_FLAGS%

61+

62+after_test:

63+ # .\ in the stack commandline seems to be .\windows\ (where the stack-appveyor.yaml is)

64+ - cd windows

65+ - .\pandoc.exe -s --toc ..\MANUAL.txt -o MANUAL.html

66+ - .\pandoc.exe -s ..\COPYING.md -o COPYING.rtf

67+ - copy ..\COPYRIGHT COPYRIGHT.txt

68+ - 7z a "pandoc-%STACK_VERSION%.zip" pandoc.exe pandoc-citeproc.exe MANUAL.html COPYING.rtf

69+ - |

70+ set VERSION=

71+ for /f "tokens=1-2 delims= " %%a in ('.\pandoc.exe --version') do ( if not defined VERSION set "VERSION=%%b" )

72+ echo %VERSION%

73+ "%WIXBIN%\\candle" -dVERSION=%VERSION% -dBINPATH=. *.wxs -out wixobj\

74+ "%WIXBIN%\\light" -sw1076 -ext WixUIExtension -ext WixUtilExtension -cultures:en-us -loc Pandoc-en-us.wxl -out "pandoc-%STACK_VERSION%.msi" wixobj\*.wixobj

75+

76+artifacts:

77+ - path: 'windows\pandoc-%STACK_VERSION%.zip'

78+ name: exe

79+ - path: 'windows\pandoc-%STACK_VERSION%.msi'

80+ name: msi

benchmark/benchmark-pandoc.hs+59−74

@@ -1,6 +1,5 @@

1−{-# LANGUAGE OverloadedStrings #-}

21{-

3−Copyright (C) 2012-2021 John MacFarlane <jgm@berkeley.edu>

2+Copyright (C) 2012-2017 John MacFarlane <jgm@berkeley.edu>

43

54This program is free software; you can redistribute it and/or modify

65it under the terms of the GNU General Public License as published by

@@ -17,87 +16,73 @@ along with this program; if not, write to the Free Software

1716Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

1817-}

1918import Text.Pandoc

20−import Text.Pandoc.MIME

21−import Control.DeepSeq (force)

22−import Control.Monad.Except (throwError)

2319import qualified Text.Pandoc.UTF8 as UTF8

20+import Data.Text (Text)

21+import Data.Time (getCurrentTime)

2422import qualified Data.ByteString as B

25−import qualified Data.Text as T

26−import Test.Tasty.Bench

27−-- import Gauge

28−import qualified Data.ByteString.Lazy as BL

23+import qualified Data.Map as Map

24+import Criterion.Main

25+import Criterion.Types (Config(..))

2926import Data.Maybe (mapMaybe)

30−import Data.List (sortOn)

27+import Debug.Trace (trace)

28+import System.Environment (getArgs)

3129

3230readerBench :: Pandoc

33− -> T.Text

31+ -> (String, ReaderOptions -> Text -> Pandoc)

3432 -> Maybe Benchmark

35−readerBench _ name

36− | name `elem` ["bibtex", "biblatex", "csljson"] = Nothing

37−readerBench doc name = either (const Nothing) Just $

38− runPure $ do

39− (rdr, rexts) <- getReader name

40− (wtr, wexts) <- getWriter name

41− case (rdr, wtr) of

42− (TextReader r, TextWriter w) -> do

43− inp <- w def{ writerWrapText = WrapAuto

44− , writerExtensions = wexts } doc

45− return $ bench (T.unpack name) $

46− nf (either (error . show) id . runPure . r def) inp

47− (ByteStringReader r, ByteStringWriter w) -> do

48− tmpl <- Just <$> compileDefaultTemplate name

49− inp <- w def{ writerWrapText = WrapAuto

50− , writerExtensions = wexts

51− , writerTemplate = tmpl } doc

52− return $ bench (T.unpack name) $

53− nf (either (error . show) id .

54− runPure . r def{readerExtensions = rexts}) inp

55− _ -> throwError $ PandocSomeError $ "text/bytestring format mismatch: "

56− <> name

33+readerBench doc (name, reader) =

34+ case lookup name writers of

35+ Just (TextWriter writer) ->

36+ let inp = either (error . show) id $ runPure

37+ $ writer def{ writerWrapText = WrapAuto} doc

38+ in return $ bench (name ++ " reader") $ nf

39+ (reader def) inp

40+ _ -> Debug.Trace.trace

41+ ("\nCould not find writer for " ++ name ++ "\n") Nothing

5742

58−getImages :: IO [(FilePath, MimeType, BL.ByteString)]

59−getImages = do

60− ll <- B.readFile "test/lalune.jpg"

61− mv <- B.readFile "test/movie.jpg"

62− return [("lalune.jpg", "image/jpg", BL.fromStrict ll)

63− ,("movie.jpg", "image/jpg", BL.fromStrict mv)]

64−

65−writerBench :: [(FilePath, MimeType, BL.ByteString)]

66− -> Pandoc

67− -> T.Text

68− -> Maybe Benchmark

69−writerBench _ _ name

70− | name `elem` ["bibtex", "biblatex", "csljson"] = Nothing

71−writerBench imgs doc name = either (const Nothing) Just $

72− runPure $ do

73− (wtr, wexts) <- getWriter name

74− case wtr of

75− TextWriter writerFun ->

76− return $ bench (T.unpack name)

77− $ nf (\d -> either (error . show) id $

78− runPure $ do

79− mapM_ (\(fp,mt,bs) -> insertMedia fp (Just mt) bs) imgs

80− writerFun def{ writerExtensions = wexts} d)

81− doc

82− ByteStringWriter writerFun ->

83− return $ bench (T.unpack name)

84− $ nf (\d -> either (error . show) id $

85− runPure $ do

86− mapM_ (\(fp,mt,bs) -> insertMedia fp (Just mt) bs) imgs

87− writerFun def{ writerExtensions = wexts} d)

88− doc

43+writerBench :: Pandoc

44+ -> (String, WriterOptions -> Pandoc -> Text)

45+ -> Benchmark

46+writerBench doc (name, writer) = bench (name ++ " writer") $ nf

47+ (writer def{ writerWrapText = WrapAuto }) doc

8948

9049main :: IO ()

9150main = do

51+ args <- getArgs

52+ let matchReader (n, TextReader _) =

53+ case args of

54+ [] -> True

55+ [x] -> x == n

56+ (x:y:_) -> x == n && y == "reader"

57+ matchReader (_, _) = False

58+ let matchWriter (n, TextWriter _) =

59+ case args of

60+ [] -> True

61+ [x] -> x == n

62+ (x:y:_) -> x == n && y == "writer"

63+ matchWriter (_, _) = False

64+ let matchedReaders = filter matchReader readers

65+ let matchedWriters = filter matchWriter writers

9266 inp <- UTF8.toText <$> B.readFile "test/testsuite.txt"

67+ lalune <- B.readFile "test/lalune.jpg"

68+ movie <- B.readFile "test/movie.jpg"

69+ time <- Data.Time.getCurrentTime

70+ let setupFakeFiles = modifyPureState $ \st -> st{ stFiles =

71+ FileTree $ Map.fromList [

72+ ("lalune.jpg", FileInfo time lalune),

73+ ("movie.jpg", FileInfo time movie)

74+ ]}

9375 let opts = def

94− let doc = either (error . show) force $ runPure $ readMarkdown opts inp

95− defaultMain

96− [ env getImages $ \imgs ->

97− bgroup "writers" $ mapMaybe (writerBench imgs doc . fst)

98− (sortOn fst

99− writers :: [(T.Text, Writer PandocPure)])

100− , bgroup "readers" $ mapMaybe (readerBench doc . fst)

101− (sortOn fst

102− readers :: [(T.Text, Reader PandocPure)])

103− ]

76+ let doc = either (error . show) id $ runPure $ readMarkdown opts inp

77+ let readers' = [(n, \o d ->

78+ either (error . show) id $ runPure $ r o d)

79+ | (n, TextReader r) <- matchedReaders]

80+ let readerBs = mapMaybe (readerBench doc)

81+ $ filter (\(n,_) -> n /="haddock") readers'

82+ let writers' = [(n, \o d ->

83+ either (error . show) id $ runPure $ setupFakeFiles >> w o d)

84+ | (n, TextWriter w) <- matchedWriters]

85+ let writerBs = map (writerBench doc)

86+ $ writers'

87+ defaultMainWith defaultConfig{ timeLimit = 6.0 }

88+ (writerBs ++ readerBs)

benchmark/weigh-pandoc.hsnew file+38

@@ -0,0 +1,38 @@

1+import Weigh

2+import Text.Pandoc

3+import Data.Text (Text)

4+

5+main :: IO ()

6+main = do

7+ doc <- read <$> readFile "test/testsuite.native"

8+ mainWith $ do

9+ func "Pandoc document" id doc

10+ mapM_

11+ (\(n,r) -> weighReader doc n (either (error . show) id . runPure . r def{readerExtensions = pandocExtensions}))

12+ [("markdown", readMarkdown)

13+ ,("html", readHtml)

14+ ,("docbook", readDocBook)

15+ ,("latex", readLaTeX)

16+ ,("commonmark", readCommonMark)

17+ ]

18+ mapM_

19+ (\(n,w) -> weighWriter doc n (either (error . show) id . runPure . w def))

20+ [("markdown", writeMarkdown)

21+ ,("html", writeHtml5String)

22+ ,("docbook", writeDocbook5)

23+ ,("latex", writeLaTeX)

24+ ,("commonmark", writeCommonMark)

25+ ]

26+

27+weighWriter :: Pandoc -> String -> (Pandoc -> Text) -> Weigh ()

28+weighWriter doc name writer = func (name ++ " writer") writer doc

29+

30+weighReader :: Pandoc -> String -> (Text -> Pandoc) -> Weigh ()

31+weighReader doc name reader = do

32+ case lookup name writers of

33+ Just (TextWriter writer) ->

34+ let inp = either (error . show) id $ runPure $ writer def{ writerWrapText = WrapAuto} doc

35+ in func (name ++ " reader") reader inp

36+ _ -> return () -- no writer for reader

37+

38+

cabal.projectdeleted−13

@@ -1,13 +0,0 @@

1−packages: pandoc.cabal

2−tests: True

3−flags: +embed_data_files

4−

5−source-repository-package

6− type: git

7− location: https://github.com/jgm/doctemplates

8− tag: 428c26d5303cf7a2b1051fe1ffd9aafe9ba71c81

9−

10−source-repository-package

11− type: git

12− location: https://github.com/jgm/citeproc

13− tag: 4ce0501cd6f9c86eee087afcf878c256e49b9615

changelog.md → changelogrenamed+9934−16687

This diff is too big to show here.

citeproc/biblatex-localization/.stringsdeleted

No changes to the content.

citeproc/biblatex-localization/UKenglish.lbx.stringsdeleted

No changes to the content.

citeproc/biblatex-localization/USenglish.lbx.stringsdeleted

No changes to the content.

citeproc/biblatex-localization/american.lbx.stringsdeleted

No changes to the content.

citeproc/biblatex-localization/australian.lbx.stringsdeleted

No changes to the content.

citeproc/biblatex-localization/austrian.lbx.stringsdeleted−1

This diff is too big to show here.

citeproc/biblatex-localization/brazil.lbx.stringsdeleted

No changes to the content.

citeproc/biblatex-localization/brazilian.lbx.stringsdeleted−233

This diff is too big to show here.

citeproc/biblatex-localization/british.lbx.stringsdeleted−3

This diff is too big to show here.

citeproc/biblatex-localization/bulgarian.lbx.stringsdeleted−28

This diff is too big to show here.

citeproc/biblatex-localization/canadian.lbx.stringsdeleted

No changes to the content.

citeproc/biblatex-localization/catalan.lbx.stringsdeleted−158

This diff is too big to show here.

citeproc/biblatex-localization/croatian.lbx.stringsdeleted−214

This diff is too big to show here.

citeproc/biblatex-localization/czech.lbx.stringsdeleted−91

This diff is too big to show here.

citeproc/biblatex-localization/danish.lbx.stringsdeleted−106

This diff is too big to show here.

citeproc/biblatex-localization/dutch.lbx.stringsdeleted−23

This diff is too big to show here.

citeproc/biblatex-localization/english.lbx.stringsdeleted−254

This diff is too big to show here.

citeproc/biblatex-localization/estonian.lbx.stringsdeleted−178

This diff is too big to show here.

citeproc/biblatex-localization/finnish.lbx.stringsdeleted−254

This diff is too big to show here.

citeproc/biblatex-localization/french.lbx.stringsdeleted−245

This diff is too big to show here.

citeproc/biblatex-localization/galician.lbx.stringsdeleted−28

This diff is too big to show here.

citeproc/biblatex-localization/german.lbx.stringsdeleted−28

This diff is too big to show here.

citeproc/biblatex-localization/greek.lbx.stringsdeleted−9

This diff is too big to show here.

citeproc/biblatex-localization/hungarian.lbx.stringsdeleted

No changes to the content.

citeproc/biblatex-localization/icelandic.lbx.stringsdeleted−7

This diff is too big to show here.

citeproc/biblatex-localization/italian.lbx.stringsdeleted−9

This diff is too big to show here.

citeproc/biblatex-localization/latvian.lbx.stringsdeleted−75

This diff is too big to show here.

citeproc/biblatex-localization/lithuanian.lbx.stringsdeleted−31

This diff is too big to show here.

citeproc/biblatex-localization/magyar.lbx.stringsdeleted−29

This diff is too big to show here.

citeproc/biblatex-localization/naustrian.lbx.stringsdeleted−2

This diff is too big to show here.

citeproc/biblatex-localization/newzealand.lbx.stringsdeleted

No changes to the content.

citeproc/biblatex-localization/ngerman.lbx.stringsdeleted−1

This diff is too big to show here.

citeproc/biblatex-localization/norsk.lbx.stringsdeleted−98

This diff is too big to show here.

citeproc/biblatex-localization/nswissgerman.lbx.stringsdeleted−2

This diff is too big to show here.

citeproc/biblatex-localization/nynorsk.lbx.stringsdeleted−28

This diff is too big to show here.

citeproc/biblatex-localization/polish.lbx.stringsdeleted−100

This diff is too big to show here.

citeproc/biblatex-localization/portuges.lbx.stringsdeleted

No changes to the content.

citeproc/biblatex-localization/portuguese.lbx.stringsdeleted−95

This diff is too big to show here.

citeproc/biblatex-localization/russian.lbx.stringsdeleted−102

This diff is too big to show here.

citeproc/biblatex-localization/serbian.lbx.stringsdeleted

No changes to the content.

citeproc/biblatex-localization/serbianc.lbx.stringsdeleted

No changes to the content.

citeproc/biblatex-localization/slovak.lbx.stringsdeleted−82

This diff is too big to show here.

citeproc/biblatex-localization/slovene.lbx.stringsdeleted−28

This diff is too big to show here.

citeproc/biblatex-localization/slovenian.lbx.stringsdeleted

No changes to the content.

citeproc/biblatex-localization/spanish.lbx.stringsdeleted−190

This diff is too big to show here.

citeproc/biblatex-localization/swedish.lbx.stringsdeleted−9

This diff is too big to show here.

citeproc/biblatex-localization/swissgerman.lbx.stringsdeleted−1

This diff is too big to show here.

citeproc/biblatex-localization/turkish.lbx.stringsdeleted−157

This diff is too big to show here.

citeproc/biblatex-localization/ukrainian.lbx.stringsdeleted−102

This diff is too big to show here.

data/LaTeXMathML.jsnew file+198

This diff is too big to show here.

data/abbreviations−30

This diff is too big to show here.

data/bash_completion.tpl+4−8

This diff is too big to show here.

data/default.csldeleted−658

This diff is too big to show here.

data/docx/[Content_Types].xml+1−1

This diff is too big to show here.

data/docx/_rels/.rels+1−2

This diff is too big to show here.

data/docx/docProps/custom.xmldeleted−2

This diff is too big to show here.

data/docx/word/settings.xml+16−6

This diff is too big to show here.

data/docx/word/styles.xml+14−26

This diff is too big to show here.

data/epub.css+5−19

This diff is too big to show here.

data/init.lua+4

This diff is too big to show here.

test/command/jats.csl → data/jats.cslrenamed+1−4

This diff is too big to show here.

data/make-reference-files.hsnew file+27

This diff is too big to show here.

data/odt/styles.xml+12−16

This diff is too big to show here.

data/pandoc.List.lua+46−68

This diff is too big to show here.

data/pandoc.lua+244−502

This diff is too big to show here.

data/pptx/[Content_Types].xml+1−1

This diff is too big to show here.

data/pptx/_rels/.rels+1−1

This diff is too big to show here.

data/pptx/docProps/app.xml+1−1

This diff is too big to show here.

data/pptx/docProps/core.xml+1−1

This diff is too big to show here.

data/pptx/docProps/thumbnail.jpegnew file

Binary file not shown.

data/pptx/ppt/_rels/presentation.xml.rels+1−1

This diff is too big to show here.

data/pptx/ppt/notesMasters/_rels/notesMaster1.xml.relsdeleted−2

This diff is too big to show here.

data/pptx/ppt/notesMasters/notesMaster1.xmldeleted−2

This diff is too big to show here.

data/pptx/ppt/notesSlides/_rels/notesSlide1.xml.relsdeleted−2

This diff is too big to show here.

data/pptx/ppt/notesSlides/_rels/notesSlide2.xml.relsdeleted−2

This diff is too big to show here.

data/pptx/ppt/notesSlides/notesSlide1.xmldeleted−2

This diff is too big to show here.

data/pptx/ppt/notesSlides/notesSlide2.xmldeleted−2

This diff is too big to show here.

data/pptx/ppt/presProps.xml+1−1

This diff is too big to show here.

data/pptx/ppt/presentation.xml+1−1

This diff is too big to show here.

data/pptx/ppt/slideLayouts/slideLayout1.xml+1−1

This diff is too big to show here.

data/pptx/ppt/slideLayouts/slideLayout10.xml+1−1

This diff is too big to show here.

data/pptx/ppt/slideLayouts/slideLayout11.xml+1−1

This diff is too big to show here.

data/pptx/ppt/slideLayouts/slideLayout2.xml+1−1

This diff is too big to show here.

data/pptx/ppt/slideLayouts/slideLayout3.xml+1−1

This diff is too big to show here.

data/pptx/ppt/slideLayouts/slideLayout4.xml+1−1

This diff is too big to show here.

data/pptx/ppt/slideLayouts/slideLayout5.xml+1−1

This diff is too big to show here.

data/pptx/ppt/slideLayouts/slideLayout6.xml+1−1

This diff is too big to show here.

data/pptx/ppt/slideLayouts/slideLayout7.xml+1−1

This diff is too big to show here.

data/pptx/ppt/slideLayouts/slideLayout8.xml+1−1

This diff is too big to show here.

data/pptx/ppt/slideLayouts/slideLayout9.xml+1−1

This diff is too big to show here.

data/pptx/ppt/slideMasters/_rels/slideMaster1.xml.rels+1−1

This diff is too big to show here.

data/pptx/ppt/slideMasters/slideMaster1.xml+1−1

This diff is too big to show here.

data/pptx/ppt/slides/_rels/slide1.xml.rels+1−1

This diff is too big to show here.

data/pptx/ppt/slides/_rels/slide2.xml.rels+1−1

This diff is too big to show here.

data/pptx/ppt/slides/_rels/slide3.xml.relsdeleted−2

This diff is too big to show here.

data/pptx/ppt/slides/_rels/slide4.xml.relsdeleted−2

This diff is too big to show here.

data/pptx/ppt/slides/slide1.xml+1−1

This diff is too big to show here.

data/pptx/ppt/slides/slide3.xmldeleted−2

This diff is too big to show here.

data/pptx/ppt/slides/slide4.xmldeleted−2

This diff is too big to show here.

data/pptx/ppt/theme/theme2.xmldeleted−2

This diff is too big to show here.

data/pptx/ppt/viewProps.xml+1−1

This diff is too big to show here.

data/sample.lua+26−42

This diff is too big to show here.

data/templates/.github/ISSUE_TEMPLATE.mdnew file+3

This diff is too big to show here.

data/templates/.github/PULL_REQUEST_TEMPLATE.mdnew file+4

This diff is too big to show here.

data/templates/README.markdownnew file+49

This diff is too big to show here.

data/templates/affiliations.jatsdeleted−38

This diff is too big to show here.

data/templates/default.asciidoc+1−4

This diff is too big to show here.

data/templates/default.asciidoctordeleted−41

This diff is too big to show here.

data/templates/default.biblatexdeleted−10

This diff is too big to show here.

data/templates/default.bibtexdeleted−10

This diff is too big to show here.

data/templates/default.context+14−50

This diff is too big to show here.

data/templates/default.docbook4+3−3

This diff is too big to show here.

data/templates/default.docbook5+3−3

This diff is too big to show here.

data/templates/default.dzslides+14−3

This diff is too big to show here.

data/templates/default.epub2+9−8

This diff is too big to show here.

data/templates/default.epub3+12−11

This diff is too big to show here.

data/templates/default.html4+12−7

This diff is too big to show here.

data/templates/default.html5+16−11

This diff is too big to show here.

data/templates/default.icml+2−2

This diff is too big to show here.

data/templates/article.jats_publishing → data/templates/default.jatsrenamed+28−36

This diff is too big to show here.

data/templates/default.jats_archivingdeleted−7

This diff is too big to show here.

data/templates/default.jats_articleauthoringdeleted−93

This diff is too big to show here.

data/templates/default.jats_publishingdeleted−7

This diff is too big to show here.

data/templates/default.jiradeleted−9

This diff is too big to show here.

data/templates/default.latex+136−270

This diff is too big to show here.

data/templates/default.man+3−3

This diff is too big to show here.

data/templates/default.ms+5−15

This diff is too big to show here.

data/templates/default.muse+1−1

This diff is too big to show here.

data/templates/default.opendocument+4−8

This diff is too big to show here.

data/templates/default.org+3−3

This diff is too big to show here.

data/templates/default.revealjs+97−144

This diff is too big to show here.

data/templates/default.rst+8−6

This diff is too big to show here.

data/templates/default.s5+12−4

This diff is too big to show here.

data/templates/default.slideous+12−8

This diff is too big to show here.

data/templates/default.slidy+12−6

This diff is too big to show here.

data/templates/default.tei+4−16

This diff is too big to show here.

data/templates/default.texinfo+22

This diff is too big to show here.

data/templates/default.xwikideleted−13

This diff is too big to show here.

data/templates/styles.htmldeleted−180

This diff is too big to show here.

data/translations/de.yaml−1

This diff is too big to show here.

data/translations/en.yaml+1−1

This diff is too big to show here.

data/translations/fr.yaml+10−10

This diff is too big to show here.

data/translations/ru.yaml+10−9

This diff is too big to show here.

data/translations/uk.yaml+1

This diff is too big to show here.

data/translations/zh-Hans.yamldeleted−22

This diff is too big to show here.

data/translations/zh-Hant.yamldeleted−22

This diff is too big to show here.

data/vimwiki.cssnew file+82

This diff is too big to show here.

default.nix+100−12

This diff is too big to show here.

doc/customizing-pandoc.mddeleted−168

This diff is too big to show here.

doc/epub.md+14−21

This diff is too big to show here.

doc/faqs.mddeleted−128

This diff is too big to show here.

doc/filters.md+162−203

This diff is too big to show here.

doc/getting-started.md+11−15

This diff is too big to show here.

doc/jats.mddeleted−414

This diff is too big to show here.

doc/libraries.mddeleted−63

This diff is too big to show here.

doc/lua-filters.md+844−2834

This diff is too big to show here.

doc/org.mddeleted−379

This diff is too big to show here.

doc/using-the-pandoc-api.md+20−34

This diff is too big to show here.

lib/fonts/Makefilenew file+6

This diff is too big to show here.

lib/fonts/parseUnicodeMapping.hsnew file+40

This diff is too big to show here.

lib/fonts/symbol.txtnew file+256

This diff is too big to show here.

linux/Dockerfilenew file+56

This diff is too big to show here.

linux/Makefilenew file+18

This diff is too big to show here.

linux/control.in+1−1

This diff is too big to show here.

linux/make_artifacts.shdeleted−84

This diff is too big to show here.

linux/make_deb.shnew file+51

This diff is too big to show here.

linux/make_tarball.shnew file+19

This diff is too big to show here.

macos/Makefiledeleted−35

This diff is too big to show here.

macos/make_macos_package.shnew file+86

This diff is too big to show here.

man/pandoc.1+3201−5328

This diff is too big to show here.

man/pandoc.1.afterdeleted−3

This diff is too big to show here.

man/pandoc.1.beforedeleted−2

This diff is too big to show here.

man/pandoc.1.templatenew file+10

This diff is too big to show here.

pandoc.cabal+206−358

This diff is too big to show here.

pandoc.hsnew file+38

This diff is too big to show here.

prelude/Prelude.hs+19−8

This diff is too big to show here.

release.nixdeleted−4

This diff is too big to show here.

shell.nixdeleted−106

This diff is too big to show here.

src/Text/Pandoc.hs+20−1

This diff is too big to show here.

src/Text/Pandoc/App.hs+1578−247

This diff is too big to show here.

src/Text/Pandoc/App/CommandLineOptions.hsdeleted−1092

This diff is too big to show here.

src/Text/Pandoc/App/FormatHeuristics.hsdeleted−90

This diff is too big to show here.

src/Text/Pandoc/App/Opt.hsdeleted−747

This diff is too big to show here.

src/Text/Pandoc/App/OutputSettings.hsdeleted−256

This diff is too big to show here.

src/Text/Pandoc/Asciify.hs+408−14

This diff is too big to show here.

src/Text/Pandoc/BCP47.hsnew file+125

This diff is too big to show here.

src/Text/Pandoc/CSS.hs+24−37

This diff is too big to show here.

src/Text/Pandoc/CSV.hs+32−11

This diff is too big to show here.

src/Text/Pandoc/Citeproc.hsdeleted−661

This diff is too big to show here.

src/Text/Pandoc/Citeproc/BibTeX.hsdeleted−1476

This diff is too big to show here.

src/Text/Pandoc/Citeproc/CslJson.hsdeleted−37

This diff is too big to show here.

src/Text/Pandoc/Citeproc/Data.hsdeleted−32

This diff is too big to show here.

src/Text/Pandoc/Citeproc/Locator.hsdeleted−295

This diff is too big to show here.

src/Text/Pandoc/Citeproc/MetaValue.hsdeleted−255

This diff is too big to show here.

src/Text/Pandoc/Citeproc/Util.hsdeleted−70

This diff is too big to show here.

src/Text/Pandoc/Class.hs+1059−14

This diff is too big to show here.

src/Text/Pandoc/Class/CommonState.hsdeleted−83

This diff is too big to show here.

src/Text/Pandoc/Class/IO.hsdeleted−231

This diff is too big to show here.

src/Text/Pandoc/Class/PandocIO.hsdeleted−74

This diff is too big to show here.

src/Text/Pandoc/Class/PandocMonad.hsdeleted−711

This diff is too big to show here.

src/Text/Pandoc/Class/PandocPure.hsdeleted−218

This diff is too big to show here.

src/Text/Pandoc/Compat/Time.hsnew file+30

This diff is too big to show here.

src/Text/Pandoc/Data.hs−10

This diff is too big to show here.

src/Text/Pandoc/Emoji.hs+892−11

This diff is too big to show here.

src/Text/Pandoc/Error.hs+82−166

This diff is too big to show here.

src/Text/Pandoc/Extensions.hs+57−306

This diff is too big to show here.

src/Text/Pandoc/Filter.hsdeleted−100

This diff is too big to show here.

src/Text/Pandoc/Filter/JSON.hsdeleted−80

This diff is too big to show here.

src/Text/Pandoc/Filter/Lua.hsdeleted−47

This diff is too big to show here.

src/Text/Pandoc/Filter/Path.hsdeleted−35

This diff is too big to show here.

src/Text/Pandoc/Highlighting.hs+44−32

This diff is too big to show here.

src/Text/Pandoc/Image.hsdeleted−37

This diff is too big to show here.

src/Text/Pandoc/ImageSize.hs+381−155

This diff is too big to show here.

src/Text/Pandoc/Logging.hs+178−252

This diff is too big to show here.

src/Text/Pandoc/Lua.hs+75−11

This diff is too big to show here.

src/Text/Pandoc/Lua/ErrorConversion.hsdeleted−61

This diff is too big to show here.

src/Text/Pandoc/Lua/Filter.hs+103−188

This diff is too big to show here.

src/Text/Pandoc/Lua/Global.hsdeleted−89

This diff is too big to show here.

src/Text/Pandoc/Lua/Init.hs+57−81

This diff is too big to show here.

src/Text/Pandoc/Lua/Marshaling.hsdeleted−19

This diff is too big to show here.

src/Text/Pandoc/Lua/Marshaling/AST.hsdeleted−378

This diff is too big to show here.

src/Text/Pandoc/Lua/Marshaling/AnyValue.hsdeleted−24

This diff is too big to show here.

src/Text/Pandoc/Lua/Marshaling/CommonState.hsdeleted−102

This diff is too big to show here.

src/Text/Pandoc/Lua/Marshaling/Context.hsdeleted−28

This diff is too big to show here.

src/Text/Pandoc/Lua/Marshaling/List.hsdeleted−43

This diff is too big to show here.

src/Text/Pandoc/Lua/Marshaling/MediaBag.hsdeleted−73

This diff is too big to show here.

src/Text/Pandoc/Lua/Marshaling/PandocError.hsdeleted−65

This diff is too big to show here.

src/Text/Pandoc/Lua/Marshaling/ReaderOptions.hsdeleted−79

This diff is too big to show here.

src/Text/Pandoc/Lua/Marshaling/SimpleTable.hsdeleted−59

This diff is too big to show here.

src/Text/Pandoc/Lua/Marshaling/Version.hsdeleted−154

This diff is too big to show here.

src/Text/Pandoc/Lua/Module/MediaBag.hs+73−68

This diff is too big to show here.

src/Text/Pandoc/Lua/Module/Pandoc.hs+74−72

This diff is too big to show here.

src/Text/Pandoc/Lua/Module/System.hsdeleted−33

This diff is too big to show here.

src/Text/Pandoc/Lua/Module/Types.hsdeleted−68

This diff is too big to show here.

src/Text/Pandoc/Lua/Module/Utils.hs+43−118

This diff is too big to show here.

src/Text/Pandoc/Lua/Packages.hs+86−31

This diff is too big to show here.

src/Text/Pandoc/Lua/PandocLua.hsdeleted−141

This diff is too big to show here.

src/Text/Pandoc/Lua/StackInstances.hsnew file+334

This diff is too big to show here.

src/Text/Pandoc/Lua/Util.hs+130−96

This diff is too big to show here.

src/Text/Pandoc/Lua/Walk.hsdeleted−158

This diff is too big to show here.

src/Text/Pandoc/MIME.hs+36−55

This diff is too big to show here.

src/Text/Pandoc/MediaBag.hs+32−61

This diff is too big to show here.

src/Text/Pandoc/Options.hs+45−154

This diff is too big to show here.

src/Text/Pandoc/PDF.hs+279−377

This diff is too big to show here.

src/Text/Pandoc/Parsing.hs+468−689

This diff is too big to show here.

src/Text/Pandoc/Pretty.hsnew file+555

This diff is too big to show here.

src/Text/Pandoc/Process.hs+50−64

This diff is too big to show here.

src/Text/Pandoc/Readers.hs+67−95

This diff is too big to show here.

src/Text/Pandoc/Readers/BibTeX.hsdeleted−77

This diff is too big to show here.

src/Text/Pandoc/Readers/CSV.hsdeleted−48

This diff is too big to show here.

src/Text/Pandoc/Readers/CommonMark.hs+215−98

This diff is too big to show here.

src/Text/Pandoc/Readers/Creole.hs+48−22

This diff is too big to show here.

src/Text/Pandoc/Readers/CslJson.hsdeleted−54

This diff is too big to show here.

src/Text/Pandoc/Readers/DocBook.hs+249−465

This diff is too big to show here.

src/Text/Pandoc/Readers/Docx.hs+283−409

This diff is too big to show here.

src/Text/Pandoc/Readers/Docx/Combine.hs+67−100

This diff is too big to show here.

src/Text/Pandoc/Readers/Docx/Fields.hsdeleted−74

This diff is too big to show here.

src/Text/Pandoc/Readers/Docx/Lists.hs+42−29

This diff is too big to show here.

src/Text/Pandoc/Readers/Docx/Parse.hs+421−509

This diff is too big to show here.

src/Text/Pandoc/Readers/Docx/Parse/Styles.hsdeleted−322

This diff is too big to show here.

src/Text/Pandoc/Readers/Docx/StyleMap.hsnew file+108

This diff is too big to show here.

src/Text/Pandoc/Readers/Docx/Util.hs+19−43

This diff is too big to show here.

src/Text/Pandoc/Readers/DokuWiki.hsdeleted−516

This diff is too big to show here.

src/Text/Pandoc/Readers/EPUB.hs+60−85

This diff is too big to show here.

src/Text/Pandoc/Readers/FB2.hsdeleted−462

This diff is too big to show here.

src/Text/Pandoc/Readers/HTML.hs+662−460

This diff is too big to show here.

src/Text/Pandoc/Readers/HTML/Parsing.hsdeleted−225

This diff is too big to show here.

src/Text/Pandoc/Readers/HTML/Table.hsdeleted−283

This diff is too big to show here.

src/Text/Pandoc/Readers/HTML/TagCategories.hsdeleted−78

This diff is too big to show here.

src/Text/Pandoc/Readers/HTML/Types.hsdeleted−97

This diff is too big to show here.

src/Text/Pandoc/Readers/Haddock.hs+41−61

This diff is too big to show here.

src/Text/Pandoc/Readers/Ipynb.hsdeleted−230

This diff is too big to show here.

src/Text/Pandoc/Readers/JATS.hs+124−158

This diff is too big to show here.

src/Text/Pandoc/Readers/Jira.hsdeleted−203

This diff is too big to show here.

src/Text/Pandoc/Readers/LaTeX.hs+2063−627

This diff is too big to show here.

src/Text/Pandoc/Readers/LaTeX/Citation.hsdeleted−210

This diff is too big to show here.

src/Text/Pandoc/Readers/LaTeX/Inline.hsdeleted−397

This diff is too big to show here.

src/Text/Pandoc/Readers/LaTeX/Lang.hsdeleted−234

This diff is too big to show here.

src/Text/Pandoc/Readers/LaTeX/Macro.hsdeleted−184

This diff is too big to show here.

src/Text/Pandoc/Readers/LaTeX/Math.hsdeleted−221

This diff is too big to show here.

src/Text/Pandoc/Readers/LaTeX/Parsing.hsdeleted−1004

This diff is too big to show here.

src/Text/Pandoc/Readers/LaTeX/SIunitx.hsdeleted−434

This diff is too big to show here.

src/Text/Pandoc/Readers/LaTeX/Table.hsdeleted−378

This diff is too big to show here.

src/Text/Pandoc/Readers/LaTeX/Types.hs+21−20

This diff is too big to show here.

src/Text/Pandoc/Readers/Man.hsdeleted−520

This diff is too big to show here.

src/Text/Pandoc/Readers/Markdown.hs+646−757

This diff is too big to show here.

src/Text/Pandoc/Readers/MediaWiki.hs+155−159

This diff is too big to show here.

src/Text/Pandoc/Readers/Metadata.hsdeleted−200

This diff is too big to show here.

src/Text/Pandoc/Readers/Muse.hs+616−809

This diff is too big to show here.

src/Text/Pandoc/Readers/Native.hs+30−15

This diff is too big to show here.

src/Text/Pandoc/Readers/OPML.hs+36−38

This diff is too big to show here.

src/Text/Pandoc/Readers/Odt.hs+49−33

This diff is too big to show here.

src/Text/Pandoc/Readers/Odt/Arrows/State.hs+27−3

This diff is too big to show here.

src/Text/Pandoc/Readers/Odt/Arrows/Utils.hs+28−10

This diff is too big to show here.

src/Text/Pandoc/Readers/Odt/Base.hs+20

This diff is too big to show here.

src/Text/Pandoc/Readers/Odt/ContentReader.hs+109−128

This diff is too big to show here.

src/Text/Pandoc/Readers/Odt/Generic/Fallible.hs+24−2

This diff is too big to show here.

src/Text/Pandoc/Readers/Odt/Generic/Namespaces.hs+20−3

This diff is too big to show here.

src/Text/Pandoc/Readers/Odt/Generic/SetMap.hs+18

This diff is too big to show here.

src/Text/Pandoc/Readers/Odt/Generic/Utils.hs+60−12

This diff is too big to show here.

src/Text/Pandoc/Readers/Odt/Generic/XMLConverter.hs+55−95

This diff is too big to show here.

src/Text/Pandoc/Readers/Odt/Namespaces.hs+23−6

This diff is too big to show here.

src/Text/Pandoc/Readers/Odt/StyleReader.hs+78−57

This diff is too big to show here.

src/Text/Pandoc/Readers/Org.hs+30−8

This diff is too big to show here.

src/Text/Pandoc/Readers/Org/BlockStarts.hs+31−18

This diff is too big to show here.

src/Text/Pandoc/Readers/Org/Blocks.hs+217−299

This diff is too big to show here.

src/Text/Pandoc/Readers/Org/DocumentTree.hs+90−194

This diff is too big to show here.

src/Text/Pandoc/Readers/Org/ExportSettings.hs+49−67

This diff is too big to show here.

src/Text/Pandoc/Readers/Org/Inlines.hs+153−156

This diff is too big to show here.

src/Text/Pandoc/Readers/Org/Meta.hs+152−202

This diff is too big to show here.

src/Text/Pandoc/Readers/Org/ParserState.hs+40−59

This diff is too big to show here.

src/Text/Pandoc/Readers/Org/Parsing.hs+35−32

This diff is too big to show here.

src/Text/Pandoc/Readers/Org/Shared.hs+49−34

This diff is too big to show here.

src/Text/Pandoc/Readers/RST.hs+425−479

This diff is too big to show here.

src/Text/Pandoc/Readers/Roff.hsdeleted−728

This diff is too big to show here.

src/Text/Pandoc/Readers/TWiki.hs+155−117

This diff is too big to show here.

src/Text/Pandoc/Readers/Textile.hs+188−176

This diff is too big to show here.

src/Text/Pandoc/Readers/TikiWiki.hs+67−69

This diff is too big to show here.

src/Text/Pandoc/Readers/Txt2Tags.hs+119−130

This diff is too big to show here.

src/Text/Pandoc/Readers/Vimwiki.hs+116−112

This diff is too big to show here.

src/Text/Pandoc/RoffChar.hsdeleted−421

This diff is too big to show here.

src/Text/Pandoc/SelfContained.hs+91−80

This diff is too big to show here.

src/Text/Pandoc/Shared.hs+283−506

This diff is too big to show here.

src/Text/Pandoc/Slides.hs+22−9

This diff is too big to show here.

src/Text/Pandoc/Sources.hsdeleted−195

This diff is too big to show here.

src/Text/Pandoc/Templates.hs+47−84

This diff is too big to show here.

src/Text/Pandoc/Translations.hs+50−59

This diff is too big to show here.

src/Text/Pandoc/UTF8.hs+41−21

This diff is too big to show here.

src/Text/Pandoc/UUID.hs+31−15

This diff is too big to show here.

src/Text/Pandoc/Writers.hs+35−61

This diff is too big to show here.

src/Text/Pandoc/Writers/AnnotatedTable.hsdeleted−323

This diff is too big to show here.

src/Text/Pandoc/Writers/AsciiDoc.hs+190−310

This diff is too big to show here.

src/Text/Pandoc/Writers/BibTeX.hsdeleted−61

This diff is too big to show here.

src/Text/Pandoc/Writers/CommonMark.hs+299−2

This diff is too big to show here.

src/Text/Pandoc/Writers/ConTeXt.hs+210−291

This diff is too big to show here.

src/Text/Pandoc/Writers/CslJson.hsdeleted−91

This diff is too big to show here.

src/Text/Pandoc/Writers/Custom.hs+122−105

This diff is too big to show here.

src/Text/Pandoc/Writers/Docbook.hs+157−208

This diff is too big to show here.

src/Text/Pandoc/Writers/Docx.hs+652−623

This diff is too big to show here.

src/Text/Pandoc/Writers/Docx/StyleMap.hsdeleted−47

This diff is too big to show here.

src/Text/Pandoc/Writers/Docx/Table.hsdeleted−227

This diff is too big to show here.

src/Text/Pandoc/Writers/Docx/Types.hsdeleted−185

This diff is too big to show here.

src/Text/Pandoc/Writers/DokuWiki.hs+199−194

This diff is too big to show here.

src/Text/Pandoc/Writers/EPUB.hs+350−488

This diff is too big to show here.

src/Text/Pandoc/Writers/FB2.hs+237−179

This diff is too big to show here.

src/Text/Pandoc/Writers/GridTable.hsdeleted−157

This diff is too big to show here.

src/Text/Pandoc/Writers/HTML.hs+752−931

This diff is too big to show here.

src/Text/Pandoc/Writers/Haddock.hs+147−88

This diff is too big to show here.

src/Text/Pandoc/Writers/ICML.hs+213−269

This diff is too big to show here.

src/Text/Pandoc/Writers/Ipynb.hsdeleted−239

This diff is too big to show here.

src/Text/Pandoc/Writers/JATS.hs+211−335

This diff is too big to show here.

src/Text/Pandoc/Writers/JATS/References.hsdeleted−164

This diff is too big to show here.

src/Text/Pandoc/Writers/JATS/Table.hsdeleted−268

This diff is too big to show here.

src/Text/Pandoc/Writers/JATS/Types.hsdeleted−57

This diff is too big to show here.

src/Text/Pandoc/Writers/Jira.hsdeleted−339

This diff is too big to show here.

src/Text/Pandoc/Writers/LaTeX.hs+975−527

This diff is too big to show here.

src/Text/Pandoc/Writers/LaTeX/Caption.hsdeleted−47

This diff is too big to show here.

src/Text/Pandoc/Writers/LaTeX/Citation.hsdeleted−181

This diff is too big to show here.

src/Text/Pandoc/Writers/LaTeX/Lang.hsdeleted−192

This diff is too big to show here.

src/Text/Pandoc/Writers/LaTeX/Notes.hsdeleted−34

This diff is too big to show here.

src/Text/Pandoc/Writers/LaTeX/Table.hsdeleted−307

This diff is too big to show here.

src/Text/Pandoc/Writers/LaTeX/Types.hsdeleted−83

This diff is too big to show here.

src/Text/Pandoc/Writers/LaTeX/Util.hsdeleted−275

This diff is too big to show here.

src/Text/Pandoc/Writers/Man.hs+186−107

This diff is too big to show here.

src/Text/Pandoc/Writers/Markdown.hs+846−410

This diff is too big to show here.

src/Text/Pandoc/Writers/Markdown/Inline.hsdeleted−616

This diff is too big to show here.

src/Text/Pandoc/Writers/Markdown/Types.hsdeleted−81

This diff is too big to show here.

src/Text/Pandoc/Writers/Math.hs+11−8

This diff is too big to show here.

src/Text/Pandoc/Writers/MediaWiki.hs+135−162

This diff is too big to show here.

src/Text/Pandoc/Writers/Ms.hs+304−279

This diff is too big to show here.

src/Text/Pandoc/Writers/Muse.hs+219−536

This diff is too big to show here.

src/Text/Pandoc/Writers/Native.hs+30−42

This diff is too big to show here.

src/Text/Pandoc/Writers/ODT.hs+73−118

This diff is too big to show here.

src/Text/Pandoc/Writers/OOXML.hs+64−54

This diff is too big to show here.

src/Text/Pandoc/Writers/OPML.hs+64−37

This diff is too big to show here.

src/Text/Pandoc/Writers/OpenDocument.hs+242−494

This diff is too big to show here.

src/Text/Pandoc/Writers/Org.hs+173−227

This diff is too big to show here.

src/Text/Pandoc/Writers/Powerpoint.hs+1723−20

This diff is too big to show here.

src/Text/Pandoc/Writers/Powerpoint/Output.hsdeleted−1922

This diff is too big to show here.

src/Text/Pandoc/Writers/Powerpoint/Presentation.hsdeleted−1004

This diff is too big to show here.

src/Text/Pandoc/Writers/RST.hs+221−410

This diff is too big to show here.

src/Text/Pandoc/Writers/RTF.hs+153−135

This diff is too big to show here.

src/Text/Pandoc/Writers/Roff.hsdeleted−125

This diff is too big to show here.

src/Text/Pandoc/Writers/Shared.hs+185−396

This diff is too big to show here.

src/Text/Pandoc/Writers/TEI.hs+126−83

This diff is too big to show here.

src/Text/Pandoc/Writers/Texinfo.hs+135−121

This diff is too big to show here.

src/Text/Pandoc/Writers/Textile.hs+175−167

This diff is too big to show here.

src/Text/Pandoc/Writers/XWiki.hsdeleted−267

This diff is too big to show here.

src/Text/Pandoc/Writers/ZimWiki.hs+162−149

This diff is too big to show here.

src/Text/Pandoc/XML.hs+60−462

This diff is too big to show here.

src/Text/Pandoc/XML/Light.hsdeleted−89

This diff is too big to show here.

src/Text/Pandoc/XML/Light/Output.hsdeleted−234

This diff is too big to show here.

src/Text/Pandoc/XML/Light/Proc.hsdeleted−139

This diff is too big to show here.

src/Text/Pandoc/XML/Light/Types.hsdeleted−193

This diff is too big to show here.

stack.lts9.yamlnew file+29

This diff is too big to show here.

stack.yaml+10−16

This diff is too big to show here.

test/Tests/Command.hs+45−86

This diff is too big to show here.

test/Tests/Helpers.hs+24−37

This diff is too big to show here.

test/Tests/Lua.hs+44−148

This diff is too big to show here.

test/Tests/Lua/Module.hsdeleted−37

This diff is too big to show here.

test/Tests/Old.hs+215−269

This diff is too big to show here.

test/Tests/Readers/Creole.hs+1−13

This diff is too big to show here.

test/Tests/Readers/Docx.hs+19−134

This diff is too big to show here.

test/Tests/Readers/DokuWiki.hsdeleted−321

This diff is too big to show here.

test/Tests/Readers/EPUB.hs+3−49

This diff is too big to show here.

test/Tests/Readers/FB2.hsdeleted−39

This diff is too big to show here.

test/Tests/Readers/HTML.hs+1−74

This diff is too big to show here.

test/Tests/Readers/JATS.hs−29

This diff is too big to show here.

test/Tests/Readers/Jira.hsdeleted−204

This diff is too big to show here.

test/Tests/Readers/LaTeX.hs+23−111

This diff is too big to show here.

test/Tests/Readers/Man.hsdeleted−144

This diff is too big to show here.

test/Tests/Readers/Markdown.hs+13−79

This diff is too big to show here.

test/Tests/Readers/Muse.hs+113−782

This diff is too big to show here.

test/Tests/Readers/Odt.hs+1−16

This diff is too big to show here.

test/Tests/Readers/Org.hs−11

This diff is too big to show here.

test/Tests/Readers/Org/Block.hs+23−44

This diff is too big to show here.

test/Tests/Readers/Org/Block/CodeBlock.hs+43−54

This diff is too big to show here.

test/Tests/Readers/Org/Block/Figure.hs+6−24

This diff is too big to show here.

test/Tests/Readers/Org/Block/Header.hs+3−93

This diff is too big to show here.

test/Tests/Readers/Org/Block/List.hs+9−44

This diff is too big to show here.

test/Tests/Readers/Org/Block/Table.hs+19−55

This diff is too big to show here.

test/Tests/Readers/Org/Directive.hs+4−164

This diff is too big to show here.

test/Tests/Readers/Org/Inline.hs+212−81

This diff is too big to show here.

test/Tests/Readers/Org/Inline/Citation.hsdeleted−230

This diff is too big to show here.

test/Tests/Readers/Org/Inline/Note.hs+1−11

This diff is too big to show here.

test/Tests/Readers/Org/Inline/Smart.hs+2−13

This diff is too big to show here.

test/Tests/Readers/Org/Meta.hs+92−211

This diff is too big to show here.

test/Tests/Readers/Org/Shared.hs+1−13

This diff is too big to show here.

test/Tests/Readers/RST.hs+24−48

This diff is too big to show here.

test/Tests/Readers/Txt2Tags.hs+23−54

This diff is too big to show here.

test/Tests/Shared.hs+18−91

This diff is too big to show here.

test/Tests/Writers/AnnotatedTable.hsdeleted−253

This diff is too big to show here.

test/Tests/Writers/AsciiDoc.hs+11−18

This diff is too big to show here.

test/Tests/Writers/ConTeXt.hs+38−129

This diff is too big to show here.

test/Tests/Writers/Docbook.hs+1−104

This diff is too big to show here.

test/Tests/Writers/Docx.hs+126−161

This diff is too big to show here.

test/Tests/Writers/FB2.hs+2−2

This diff is too big to show here.

test/Tests/Writers/HTML.hs+13−62

This diff is too big to show here.

test/Tests/Writers/JATS.hs+95−135

This diff is too big to show here.

test/Tests/Writers/Jira.hsdeleted−124

This diff is too big to show here.

test/Tests/Writers/LaTeX.hs+2−2

This diff is too big to show here.

test/Tests/Writers/Markdown.hs+27−29

This diff is too big to show here.

test/Tests/Writers/Ms.hsdeleted−35

This diff is too big to show here.

test/Tests/Writers/Muse.hs+128−417

This diff is too big to show here.

test/Tests/Writers/Native.hs+2−2

This diff is too big to show here.

test/Tests/Writers/OOXML.hsdeleted−187

This diff is too big to show here.

test/Tests/Writers/Org.hs+11−46

This diff is too big to show here.

test/Tests/Writers/Plain.hs+1−3

This diff is too big to show here.

test/Tests/Writers/Powerpoint.hs+90−121

This diff is too big to show here.

test/Tests/Writers/RST.hs+10−81

This diff is too big to show here.

test/Tests/Writers/TEI.hs+1−1

This diff is too big to show here.

test/command/01.csvdeleted−4

This diff is too big to show here.

test/command/1126.mddeleted−28

This diff is too big to show here.

test/command/1279.md+1−1

This diff is too big to show here.

test/command/1592.md−21

This diff is too big to show here.

test/command/1608.mddeleted−41

This diff is too big to show here.

test/command/1710.md+9−5

This diff is too big to show here.

test/command/1762.mddeleted−18

This diff is too big to show here.

test/command/1881.md+18−50

This diff is too big to show here.

test/command/2103.mddeleted−8

This diff is too big to show here.

test/command/2118.md+1−1

This diff is too big to show here.

test/command/2378.md+3−3

This diff is too big to show here.

test/command/2649.md+9−11

This diff is too big to show here.

test/command/2662.md+1−1

This diff is too big to show here.

test/command/2874.md+2−2

This diff is too big to show here.

test/command/3123.mddeleted−13

This diff is too big to show here.

test/command/3324.mddeleted−18

This diff is too big to show here.

test/command/3348.md+7−20

This diff is too big to show here.

test/command/3407.md+2−2

This diff is too big to show here.

test/command/3432.md+1−1

This diff is too big to show here.

test/command/3450.md+1−1

This diff is too big to show here.

test/command/3494.md+1−1

This diff is too big to show here.

test/command/3516.md+14−44

This diff is too big to show here.

test/command/3523.mddeleted−31

This diff is too big to show here.

test/command/3530.md+5−2

This diff is too big to show here.

test/command/3531.md+1

This diff is too big to show here.

test/command/3533-rst-csv-tables.md+25−77

This diff is too big to show here.

test/command/3534.md−22

This diff is too big to show here.

test/command/3558.md+2−2

This diff is too big to show here.

test/command/3568.md+3−4

This diff is too big to show here.

test/command/3577.md+5−3

This diff is too big to show here.

test/command/3587.md+2−128

This diff is too big to show here.

test/command/3674.md+1−1

This diff is too big to show here.

test/command/3675.md+2−2

This diff is too big to show here.

test/command/3706.md+17−38

This diff is too big to show here.

test/command/3708.md+7−20

This diff is too big to show here.

test/command/3716.md+1−1

This diff is too big to show here.

test/command/3734.md+22−4

This diff is too big to show here.

test/command/3736.md+6−3

This diff is too big to show here.

test/command/3752.mddeleted−60

This diff is too big to show here.

test/command/3792.md+1−1

This diff is too big to show here.

test/command/3804.md+1−1

This diff is too big to show here.

test/command/3824.md+1−1

This diff is too big to show here.

test/command/3947.md+1−1

This diff is too big to show here.

test/command/3968.md+2−3

This diff is too big to show here.

test/command/3983.md+3−3

This diff is too big to show here.

test/command/4012.md+1−1

This diff is too big to show here.

test/command/4016.md+11−6

This diff is too big to show here.

test/command/4056.md+8−19

This diff is too big to show here.

test/command/4063.mddeleted−29

This diff is too big to show here.

test/command/4119.md+5−19

This diff is too big to show here.

test/command/4159.md+1−2

This diff is too big to show here.

test/command/4164.md+10−6

This diff is too big to show here.

test/command/4186.mddeleted−60

This diff is too big to show here.

test/command/4235.mddeleted−12

This diff is too big to show here.

test/command/4240.mddeleted−33

This diff is too big to show here.

test/command/4253.mddeleted−8

This diff is too big to show here.

test/command/4254.mddeleted−12

This diff is too big to show here.

test/command/4280.mddeleted−7

This diff is too big to show here.

test/command/4281.mddeleted−18

This diff is too big to show here.

test/command/4284.mddeleted−40

This diff is too big to show here.

test/command/4306.mddeleted−10

This diff is too big to show here.

test/command/4320.mddeleted−29

This diff is too big to show here.

test/command/4374.mddeleted−7

This diff is too big to show here.

test/command/4382.mddeleted−10

This diff is too big to show here.

test/command/4420.mddeleted−11

This diff is too big to show here.

test/command/4424.mddeleted−10

This diff is too big to show here.

test/command/4442.mddeleted−9

This diff is too big to show here.

test/command/4454.mddeleted−9

This diff is too big to show here.

test/command/4465.mddeleted−15

This diff is too big to show here.

test/command/4499.mddeleted−87

This diff is too big to show here.

test/command/4513.mddeleted−20

This diff is too big to show here.

test/command/4527.mddeleted−36

This diff is too big to show here.

test/command/4528.mddeleted−156

This diff is too big to show here.

test/command/4529.mddeleted−36

This diff is too big to show here.

test/command/4545.mddeleted−20

This diff is too big to show here.

test/command/4550.mddeleted−7

This diff is too big to show here.

test/command/4553.mddeleted−15

This diff is too big to show here.

test/command/4576.mddeleted−6

This diff is too big to show here.

test/command/4578.mddeleted−14

This diff is too big to show here.

test/command/4579.mddeleted−30

This diff is too big to show here.

test/command/4589.mddeleted−14

This diff is too big to show here.

test/command/4594.mddeleted−24

This diff is too big to show here.

test/command/4598.mddeleted−10

This diff is too big to show here.

test/command/4624.mddeleted−30

This diff is too big to show here.

test/command/4635.mddeleted−31

This diff is too big to show here.

test/command/4637.mddeleted−6

This diff is too big to show here.

test/command/4639.mddeleted−10

This diff is too big to show here.

test/command/4653.mddeleted−8

This diff is too big to show here.

test/command/4667.mddeleted−20

This diff is too big to show here.

test/command/4669.mddeleted−29

This diff is too big to show here.

test/command/4677.mddeleted−8

This diff is too big to show here.

test/command/4690.mddeleted−26

This diff is too big to show here.

test/command/4715.mddeleted−16

This diff is too big to show here.

test/command/4722.mddeleted−34

This diff is too big to show here.

test/command/4742.mddeleted−29

This diff is too big to show here.

test/command/4743.mddeleted−25

This diff is too big to show here.

test/command/4748.mddeleted−16

This diff is too big to show here.

test/command/4768.mddeleted−7

This diff is too big to show here.

test/command/4781.mddeleted−22

This diff is too big to show here.

test/command/4794.mddeleted−17

This diff is too big to show here.

test/command/4805-beamer-columns-alignment.mddeleted−40

This diff is too big to show here.

test/command/4811.mddeleted−48

This diff is too big to show here.

test/command/4817.mddeleted−10

This diff is too big to show here.

test/command/4819.mddeleted−50

This diff is too big to show here.

test/command/4832.mddeleted−21

This diff is too big to show here.

test/command/4833.mddeleted−20

This diff is too big to show here.

test/command/4842.mddeleted−6

This diff is too big to show here.

test/command/4845.mddeleted−6

This diff is too big to show here.

test/command/4848.mddeleted−59

This diff is too big to show here.

test/command/4860.mddeleted−9

This diff is too big to show here.

test/command/4877.mddeleted−13

This diff is too big to show here.

test/command/4880.mddeleted−7

This diff is too big to show here.

test/command/4885.mddeleted−8

This diff is too big to show here.

test/command/4908.mddeleted−16

This diff is too big to show here.

test/command/4913.mddeleted−34

This diff is too big to show here.

test/command/4919.mddeleted−14

This diff is too big to show here.

test/command/4928.mddeleted−48

This diff is too big to show here.

test/command/4933.mddeleted−6

This diff is too big to show here.

test/command/4960.mddeleted−22

This diff is too big to show here.

test/command/5010.mddeleted−21

This diff is too big to show here.

test/command/5014.mddeleted−30

This diff is too big to show here.

test/command/5039.mddeleted−27

This diff is too big to show here.

test/command/5050.mddeleted−7

This diff is too big to show here.

test/command/5053.mddeleted−14

This diff is too big to show here.

test/command/5072.mddeleted−14

This diff is too big to show here.

test/command/5079.mddeleted−25

This diff is too big to show here.

test/command/5080.mddeleted−13

This diff is too big to show here.

test/command/5099.mddeleted−13

This diff is too big to show here.

test/command/5107.mddeleted−23

This diff is too big to show here.

test/command/5119.mddeleted−9

This diff is too big to show here.

test/command/5121.mddeleted−12

This diff is too big to show here.

test/command/5128.mddeleted−26

This diff is too big to show here.

test/command/5177.mddeleted−12

This diff is too big to show here.

test/command/5178.mddeleted−41

This diff is too big to show here.

test/command/5182.mddeleted−6

This diff is too big to show here.

test/command/5182.txtdeleted−5

This diff is too big to show here.

test/command/5195.mddeleted−7

This diff is too big to show here.

test/command/5233.mddeleted−9

This diff is too big to show here.

test/command/5241.mddeleted−12

This diff is too big to show here.

test/command/5271.mddeleted−12

This diff is too big to show here.

test/command/5285.mddeleted−32

This diff is too big to show here.

test/command/5304.mddeleted−24

This diff is too big to show here.

test/command/5321.mddeleted−24

This diff is too big to show here.

test/command/5340.mddeleted−14

This diff is too big to show here.

test/command/5360.mddeleted−19

This diff is too big to show here.

test/command/5367.mddeleted−43

This diff is too big to show here.

test/command/5368.mddeleted−23

This diff is too big to show here.

test/command/5369.mddeleted−7

This diff is too big to show here.

test/command/5407.mddeleted−14

This diff is too big to show here.

test/command/5410.mddeleted−7

This diff is too big to show here.

test/command/5416.mddeleted−13

This diff is too big to show here.

test/command/5420.mddeleted−6

This diff is too big to show here.

test/command/5439.mddeleted−6

This diff is too big to show here.

test/command/5446.mddeleted−6

This diff is too big to show here.

test/command/5474-figures.mddeleted−15

This diff is too big to show here.

test/command/5474-tables.mddeleted−63

This diff is too big to show here.

test/command/5476.mddeleted−12

This diff is too big to show here.

test/command/5495.mddeleted−18

This diff is too big to show here.

test/command/5519.mddeleted−14

This diff is too big to show here.

test/command/5529.mddeleted−10

This diff is too big to show here.

test/command/5540.mddeleted−8

This diff is too big to show here.

test/command/5541-localLink.mddeleted−149

This diff is too big to show here.

test/command/5541-nesting.mddeleted−98

This diff is too big to show here.

test/command/5541-urlLink.mddeleted−112

This diff is too big to show here.

test/command/5543.mddeleted−8

This diff is too big to show here.

test/command/5549.mddeleted−9

This diff is too big to show here.

test/command/5565.mddeleted−6

This diff is too big to show here.

test/command/5566.mddeleted−6

This diff is too big to show here.

test/command/5574.mddeleted−8

This diff is too big to show here.

test/command/5619.mddeleted−10

This diff is too big to show here.

test/command/5620.mddeleted−9

This diff is too big to show here.

test/command/5627.mddeleted−83

This diff is too big to show here.

test/command/5635.mddeleted−23

This diff is too big to show here.

test/command/5642.mddeleted−8

This diff is too big to show here.

test/command/5650.mddeleted−22

This diff is too big to show here.

test/command/5654.mddeleted−6

This diff is too big to show here.

test/command/5655.mddeleted−14

This diff is too big to show here.

test/command/5682.mddeleted−8

This diff is too big to show here.

test/command/5684.mddeleted−6

This diff is too big to show here.

test/command/5686.mddeleted−9

This diff is too big to show here.

test/command/5690.mddeleted−16

This diff is too big to show here.

test/command/5700-metadata-file-1.ymldeleted−1

This diff is too big to show here.

test/command/5700-metadata-file-2.ymldeleted−2

This diff is too big to show here.

test/command/5700.mddeleted−6

This diff is too big to show here.

test/command/5705.mddeleted−11

This diff is too big to show here.

test/command/5708.mddeleted−22

This diff is too big to show here.

test/command/5711.mddeleted−22

This diff is too big to show here.

test/command/5714.mddeleted−13

This diff is too big to show here.

test/command/5740.mddeleted−9

This diff is too big to show here.

test/command/5753.mddeleted−15

This diff is too big to show here.

test/command/5795.mddeleted−20

This diff is too big to show here.

test/command/5797.mddeleted−20

This diff is too big to show here.

test/command/5805.mddeleted−20

This diff is too big to show here.

test/command/5813.mddeleted−6

This diff is too big to show here.

test/command/5819.mddeleted−18

This diff is too big to show here.

test/command/5836.mddeleted−27

This diff is too big to show here.

test/command/5845.mddeleted−16

This diff is too big to show here.

test/command/5846.mddeleted−170

This diff is too big to show here.

test/command/5849-prefix.mddeleted−31

This diff is too big to show here.

test/command/5857.mddeleted−11

This diff is too big to show here.

test/command/5878.mddeleted−7

This diff is too big to show here.

test/command/5881.mddeleted−14

This diff is too big to show here.

test/command/5885.mddeleted−20

This diff is too big to show here.

test/command/5898.mddeleted−36

This diff is too big to show here.

test/command/5899.mddeleted−51

This diff is too big to show here.

test/command/5904.mddeleted−10

This diff is too big to show here.

test/command/5918.mddeleted−6

This diff is too big to show here.

test/command/5936.mddeleted−40

This diff is too big to show here.

test/command/5967.mddeleted−15

This diff is too big to show here.

test/command/5986.mddeleted−17

This diff is too big to show here.

test/command/6009.mddeleted−18

This diff is too big to show here.

test/command/6026.mddeleted−19

This diff is too big to show here.

test/command/6030.mddeleted−96

This diff is too big to show here.

test/command/6033.mddeleted−91

This diff is too big to show here.

test/command/6034.mddeleted−11

This diff is too big to show here.

test/command/6043.mddeleted−8

This diff is too big to show here.

test/command/6062.mddeleted−6

This diff is too big to show here.

test/command/6107.mddeleted−27

This diff is too big to show here.

test/command/6114.mddeleted−7

This diff is too big to show here.

test/command/6119.mddeleted−10

This diff is too big to show here.

test/command/6133.mddeleted−12

This diff is too big to show here.

test/command/6137.mddeleted−47

This diff is too big to show here.

test/command/6194.mddeleted−14

This diff is too big to show here.

test/command/6265.mddeleted−6

This diff is too big to show here.

test/command/6288.mddeleted−8

This diff is too big to show here.

test/command/6296.mddeleted−14

This diff is too big to show here.

test/command/6308.mddeleted−18

This diff is too big to show here.

test/command/6324.mddeleted−17

This diff is too big to show here.

test/command/6360.mddeleted−6

This diff is too big to show here.

test/command/6385.mddeleted−18

This diff is too big to show here.

test/command/6388.mddeleted−16

This diff is too big to show here.

test/command/6481.mddeleted−38

This diff is too big to show here.

test/command/6541.mddeleted−27

This diff is too big to show here.

test/command/6549.mddeleted−26

This diff is too big to show here.

test/command/6620.mddeleted−18

This diff is too big to show here.

test/command/6658.mddeleted−75

This diff is too big to show here.

test/command/6675.mddeleted−134

This diff is too big to show here.

test/command/6699.mddeleted−13

This diff is too big to show here.

test/command/6709.mddeleted−11

This diff is too big to show here.

test/command/6719.mddeleted−18

This diff is too big to show here.

test/command/6723.mddeleted−32

This diff is too big to show here.

test/command/6739.mddeleted−21

This diff is too big to show here.

test/command/6740.mddeleted−7

This diff is too big to show here.

test/command/6741.mddeleted−145

This diff is too big to show here.

test/command/6752.mddeleted−36

This diff is too big to show here.

test/command/6755.mddeleted−11

This diff is too big to show here.

test/command/6765.mddeleted−31

This diff is too big to show here.

test/command/6768.mddeleted−21

This diff is too big to show here.

test/command/6774.mddeleted−63

This diff is too big to show here.

test/command/6783.mddeleted−26

This diff is too big to show here.

test/command/6791.mddeleted−32

This diff is too big to show here.

test/command/6792.mddeleted−66

This diff is too big to show here.

test/command/6796.mddeleted−16

This diff is too big to show here.

test/command/6802.mddeleted−9

This diff is too big to show here.

test/command/6836.mddeleted−17

This diff is too big to show here.

test/command/6837.mddeleted−29

This diff is too big to show here.

test/command/6844.mddeleted−27

This diff is too big to show here.

test/command/6855.mddeleted−12

This diff is too big to show here.

test/command/6858.mddeleted−52

This diff is too big to show here.

test/command/6869.mddeleted−6

This diff is too big to show here.

test/command/6873.mddeleted−7

This diff is too big to show here.

test/command/6890.mddeleted−36

This diff is too big to show here.

test/command/6925.mddeleted−34

This diff is too big to show here.

test/command/6948.mddeleted−31

This diff is too big to show here.

test/command/6951.mddeleted−18

This diff is too big to show here.

test/command/6958.mddeleted−10

This diff is too big to show here.

test/command/6993.mddeleted−21

This diff is too big to show here.

test/command/7003.mddeleted−37

This diff is too big to show here.

test/command/7006.mddeleted−20

This diff is too big to show here.

test/command/7009.mddeleted−8

This diff is too big to show here.

test/command/7016.mddeleted−48

This diff is too big to show here.

test/command/7041.mddeleted−23

This diff is too big to show here.

test/command/7042.mddeleted−146

This diff is too big to show here.

test/command/7058.mddeleted−6

This diff is too big to show here.

test/command/7064.mddeleted−32

This diff is too big to show here.

test/command/7067.mddeleted−90

This diff is too big to show here.

test/command/7080.mddeleted−8

This diff is too big to show here.

test/command/7092.mddeleted−8

This diff is too big to show here.

test/command/7099.mddeleted−18

This diff is too big to show here.

test/command/7112.mddeleted−15

This diff is too big to show here.

test/command/7129.mddeleted−27

This diff is too big to show here.

test/command/7132.mddeleted−10

This diff is too big to show here.

test/command/7134.mddeleted−16

This diff is too big to show here.

test/command/7145.mddeleted−12

This diff is too big to show here.

test/command/7155.mddeleted−15

This diff is too big to show here.

test/command/7173.mddeleted−137

This diff is too big to show here.

test/command/7208.mddeleted−6

This diff is too big to show here.

test/command/7214.mddeleted−28

This diff is too big to show here.

test/command/7216.mddeleted−19

This diff is too big to show here.

test/command/7266.mddeleted−10

This diff is too big to show here.

test/command/7272.mddeleted−27

This diff is too big to show here.

test/command/7278.mddeleted−38

This diff is too big to show here.

test/command/7282.mddeleted−7

This diff is too big to show here.

test/command/7288.mddeleted−40

This diff is too big to show here.

test/command/7299.mddeleted−23

This diff is too big to show here.

test/command/7321.mddeleted−24

This diff is too big to show here.

test/command/7323.mddeleted−29

This diff is too big to show here.

test/command/7324.mddeleted−25

This diff is too big to show here.

test/command/7339.mddeleted−11

This diff is too big to show here.

test/command/7340.mddeleted−6

This diff is too big to show here.

test/command/7376.mddeleted−16

This diff is too big to show here.

test/command/7394.mddeleted−85

This diff is too big to show here.

test/command/7397.mddeleted−14

This diff is too big to show here.

test/command/7400.mddeleted−9

This diff is too big to show here.

test/command/7416.mddeleted−19

This diff is too big to show here.

test/command/A.txtdeleted−1

This diff is too big to show here.

test/command/B.txtdeleted−1

This diff is too big to show here.

test/command/C.txtdeleted−1

This diff is too big to show here.

test/command/D.txtdeleted−1

This diff is too big to show here.

test/command/adjacent_latex_blocks.mddeleted−9

This diff is too big to show here.

test/command/advanced-optical-materials.csldeleted−155

This diff is too big to show here.

test/command/annales.csldeleted−334

This diff is too big to show here.

test/command/apa.csldeleted−474

This diff is too big to show here.

test/command/archeologie-medievale.csldeleted−291

This diff is too big to show here.

test/command/ascii.mddeleted−89

This diff is too big to show here.

test/command/averroes.bibdeleted−95

This diff is too big to show here.

test/command/bar.texdeleted−1

This diff is too big to show here.

test/command/biblatex-266.mddeleted−34

This diff is too big to show here.

test/command/biblatex-aksin.mddeleted−78

This diff is too big to show here.

test/command/biblatex-almendro.mddeleted−71

This diff is too big to show here.

test/command/biblatex-angenendt.mddeleted−66

This diff is too big to show here.

test/command/biblatex-aristotle-anima.mddeleted−62

This diff is too big to show here.

test/command/biblatex-aristotle-physics.mddeleted−63

This diff is too big to show here.

test/command/biblatex-aristotle-poetics.mddeleted−65

This diff is too big to show here.

test/command/biblatex-aristotle-rhetoric.mddeleted−80

This diff is too big to show here.

test/command/biblatex-article.mddeleted−128

This diff is too big to show here.

test/command/biblatex-augustine.mddeleted−56

This diff is too big to show here.

test/command/biblatex-averroes-bland.mddeleted−85

This diff is too big to show here.

test/command/biblatex-averroes-hannes.mddeleted−84

This diff is too big to show here.

test/command/biblatex-averroes-hercz.mddeleted−85

This diff is too big to show here.

test/command/biblatex-baez-article.mddeleted−76

This diff is too big to show here.

test/command/biblatex-baez-online.mddeleted−69

This diff is too big to show here.

test/command/biblatex-basic.mddeleted−71

This diff is too big to show here.

test/command/biblatex-bertram.mddeleted−66

This diff is too big to show here.

test/command/biblatex-bibstring-resolution.mddeleted−20

This diff is too big to show here.

test/command/biblatex-book-averroes.mddeleted−129

This diff is too big to show here.

test/command/biblatex-book-coleridge.mddeleted−59

This diff is too big to show here.

test/command/biblatex-book-title-maintitle-series.mddeleted−39

This diff is too big to show here.

test/command/biblatex-book-vazques-de-parga.mddeleted−48

This diff is too big to show here.

test/command/biblatex-brandt.mddeleted−88

This diff is too big to show here.

test/command/biblatex-britannica.mddeleted−85

This diff is too big to show here.

test/command/biblatex-chiu.mddeleted−77

This diff is too big to show here.

test/command/biblatex-cicero.mddeleted−82

This diff is too big to show here.

test/command/biblatex-cms.mddeleted−81

This diff is too big to show here.

test/command/biblatex-coleridge.mddeleted−86

This diff is too big to show here.

test/command/biblatex-companion.mddeleted−70

This diff is too big to show here.

test/command/biblatex-cotton.mddeleted−69

This diff is too big to show here.

test/command/biblatex-crossref-inbook-mvbook.mddeleted−58

This diff is too big to show here.

test/command/biblatex-crossref-nested.mddeleted−100

This diff is too big to show here.

test/command/biblatex-ctan.mddeleted−73

This diff is too big to show here.

test/command/biblatex-dates.mddeleted−162

This diff is too big to show here.

test/command/biblatex-doody.mddeleted−101

This diff is too big to show here.

test/command/biblatex-edtf-date.mddeleted−72

This diff is too big to show here.

test/command/biblatex-escapedquotes.mddeleted−51

This diff is too big to show here.

test/command/biblatex-formatting.mddeleted−23

This diff is too big to show here.

test/command/biblatex-gaonkar-in.mddeleted−62

This diff is too big to show here.

test/command/biblatex-gaonkar.mddeleted−59

This diff is too big to show here.

test/command/biblatex-geer.mddeleted−70

This diff is too big to show here.

test/command/biblatex-gerhardt.mddeleted−64

This diff is too big to show here.

test/command/biblatex-gillies.mddeleted−69

This diff is too big to show here.

test/command/biblatex-glashow.mddeleted−51

This diff is too big to show here.

test/command/biblatex-gonzalez.mddeleted−62

This diff is too big to show here.

test/command/biblatex-hammond.mddeleted−63

This diff is too big to show here.

test/command/biblatex-herrmann.mddeleted−70

This diff is too big to show here.

test/command/biblatex-hyman.mddeleted−79

This diff is too big to show here.

test/command/biblatex-iliad.mddeleted−68

This diff is too big to show here.

test/command/biblatex-inbook-title-booktitle-maintitle-series-2.mddeleted−48

This diff is too big to show here.

test/command/biblatex-inbook-title-booktitle-maintitle-series.mddeleted−44

This diff is too big to show here.

test/command/biblatex-inbook.mddeleted−147

This diff is too big to show here.

test/command/biblatex-incollection-2.mddeleted−98

This diff is too big to show here.

test/command/biblatex-incollection.mddeleted−130

This diff is too big to show here.

test/command/biblatex-inproceedings.mddeleted−88

This diff is too big to show here.

test/command/biblatex-issue288.mddeleted−35

This diff is too big to show here.

test/command/biblatex-itzhaki.mddeleted−82

This diff is too big to show here.

test/command/biblatex-jaffe.mddeleted−82

This diff is too big to show here.

test/command/biblatex-jcg.mddeleted−54

This diff is too big to show here.

test/command/biblatex-kant-kpv.mddeleted−90

This diff is too big to show here.

test/command/biblatex-kant-ku.mddeleted−82

This diff is too big to show here.

test/command/biblatex-kastenholz.mddeleted−126

This diff is too big to show here.

test/command/biblatex-knuth-ct-a.mddeleted−78

This diff is too big to show here.

test/command/biblatex-knuth-ct-b.mddeleted−70

This diff is too big to show here.

test/command/biblatex-knuth-ct-c.mddeleted−69

This diff is too big to show here.

test/command/biblatex-knuth-ct-d.mddeleted−71

This diff is too big to show here.

test/command/biblatex-knuth-ct-e.mddeleted−66

This diff is too big to show here.

test/command/biblatex-knuth-ct-related.mddeleted−72

This diff is too big to show here.

test/command/biblatex-knuth-ct.mddeleted−66

This diff is too big to show here.

test/command/biblatex-kowalik.mddeleted−68

This diff is too big to show here.

test/command/biblatex-kullback-related.mddeleted−62

This diff is too big to show here.

test/command/biblatex-kullback-reprint.mddeleted−71

This diff is too big to show here.

test/command/biblatex-kullback.mddeleted−52

This diff is too big to show here.

test/command/biblatex-laufenberg.mddeleted−109

This diff is too big to show here.

test/command/biblatex-loh.mddeleted−65

This diff is too big to show here.

test/command/biblatex-malinowski.mddeleted−67

This diff is too big to show here.

test/command/biblatex-manual.mddeleted−51

This diff is too big to show here.

test/command/biblatex-markey.mddeleted−65

This diff is too big to show here.

test/command/biblatex-maron.mddeleted−70

This diff is too big to show here.

test/command/biblatex-massa.mddeleted−56

This diff is too big to show here.

test/command/biblatex-moore-related.mddeleted−66

This diff is too big to show here.

test/command/biblatex-moore.mddeleted−56

This diff is too big to show here.

test/command/biblatex-moraux.mddeleted−94

This diff is too big to show here.

test/command/biblatex-murray.mddeleted−105

This diff is too big to show here.

test/command/biblatex-nietzsche-historie.mddeleted−100

This diff is too big to show here.

test/command/biblatex-nietzsche-ksa.mddeleted−89

This diff is too big to show here.

test/command/biblatex-nietzsche-ksa1.mddeleted−95

This diff is too big to show here.

test/command/biblatex-online.mddeleted−64

This diff is too big to show here.

test/command/biblatex-options-url-false-doi-false.mddeleted−57

This diff is too big to show here.

test/command/biblatex-padhye.mddeleted−117

This diff is too big to show here.

test/command/biblatex-patent.mddeleted−158

This diff is too big to show here.

test/command/biblatex-periodical.mddeleted−31

This diff is too big to show here.

test/command/biblatex-piccato.mddeleted−59

This diff is too big to show here.

test/command/biblatex-pines.mddeleted−77

This diff is too big to show here.

test/command/biblatex-quotes.mddeleted−44

This diff is too big to show here.

test/command/biblatex-reese.mddeleted−71

This diff is too big to show here.

test/command/biblatex-report.mddeleted−119

This diff is too big to show here.

test/command/biblatex-salam.mddeleted−69

This diff is too big to show here.

test/command/biblatex-sarfraz.mddeleted−65

This diff is too big to show here.

test/command/biblatex-shore.mddeleted−66

This diff is too big to show here.

test/command/biblatex-sigfridsson.mddeleted−106

This diff is too big to show here.

test/command/biblatex-sorace.mddeleted−65

This diff is too big to show here.

test/command/biblatex-spiegelberg.mddeleted−74

This diff is too big to show here.

test/command/biblatex-springer.mddeleted−58

This diff is too big to show here.

test/command/biblatex-strings.mddeleted−46

This diff is too big to show here.

test/command/biblatex-test-case-conversion.mddeleted−73

This diff is too big to show here.

test/command/biblatex-textnormal.mddeleted−17

This diff is too big to show here.

test/command/biblatex-thesis.mddeleted−68

This diff is too big to show here.

test/command/biblatex-title-and-shorttitle.mddeleted−76

This diff is too big to show here.

test/command/biblatex-vangennep-related.mddeleted−69

This diff is too big to show here.

test/command/biblatex-vangennep-trans.mddeleted−69

This diff is too big to show here.

test/command/biblatex-vangennep.mddeleted−61

This diff is too big to show here.

test/command/biblatex-vazques-de-parga-mvbook.mddeleted−75

This diff is too big to show here.

test/command/biblatex-vazques-de-parga.mddeleted−74

This diff is too big to show here.

test/command/biblatex-video.mddeleted−19

This diff is too big to show here.

test/command/biblatex-vizedom-related.mddeleted−68

This diff is too big to show here.

test/command/biblatex-wassenberg.mddeleted−83

This diff is too big to show here.

test/command/biblatex-weinberg.mddeleted−52

This diff is too big to show here.

test/command/biblatex-westfahl-frontier.mddeleted−60

This diff is too big to show here.

test/command/biblatex-westfahl-space.mddeleted−106

This diff is too big to show here.

test/command/biblatex-wilde.mddeleted−65

This diff is too big to show here.

test/command/biblatex-worman.mddeleted−60

This diff is too big to show here.

test/command/biblatex-yoon.mddeleted−67

This diff is too big to show here.

test/command/biblio.bibdeleted−26

This diff is too big to show here.

test/command/bibtex-basic.mddeleted−71

This diff is too big to show here.

test/command/bioethics.csldeleted−226

This diff is too big to show here.

test/command/chap1/spider.pngdeleted

Binary file not shown.

test/command/chap1/text.mddeleted−17

This diff is too big to show here.

test/command/chap2/spider.pngdeleted

Binary file not shown.

test/command/chap2/text.mddeleted−5

This diff is too big to show here.

test/command/chicago-annotated-bibliography.csldeleted−1207

This diff is too big to show here.

test/command/chicago-author-date-with-original-date-and-status.csldeleted−575

This diff is too big to show here.

test/command/chicago-fullnote-bibliography.csldeleted−1430

This diff is too big to show here.

test/command/chicago-note-bibliography.csldeleted−1005

This diff is too big to show here.

test/command/chinese-gb7714-2005-numeric.csldeleted−213

This diff is too big to show here.

test/command/cite-in-inline-note.mddeleted−6

This diff is too big to show here.

test/command/citeproc-17.mddeleted−17

This diff is too big to show here.

test/command/citeproc-20.mddeleted−25

This diff is too big to show here.

test/command/citeproc-7a.mddeleted−42

This diff is too big to show here.

test/command/citeproc-7b.mddeleted−36

This diff is too big to show here.

test/command/citeproc-author-in-text-suffix.mddeleted−6

This diff is too big to show here.

test/command/csv.mddeleted−46

This diff is too big to show here.

test/command/custom-attributes.htmlnew file+16

This diff is too big to show here.

test/command/defaults-inheritance-1.mddeleted−6

This diff is too big to show here.

test/command/defaults-inheritance-2.mddeleted−5

This diff is too big to show here.

test/command/defaults-inheritance-3.mddeleted−6

This diff is too big to show here.

test/command/defaults1.yamldeleted−1

This diff is too big to show here.

test/command/defaults2.yamldeleted−4

This diff is too big to show here.

test/command/defaults3.yamldeleted−4

This diff is too big to show here.

test/command/defaults4.yamldeleted−3

This diff is too big to show here.

test/command/defaults5.yamldeleted−2

This diff is too big to show here.

test/command/defaults6.yamldeleted−2

This diff is too big to show here.

test/command/defaults7.yamldeleted−2

This diff is too big to show here.

test/command/defaults8.yamldeleted−2

This diff is too big to show here.

test/command/defaults9.yamldeleted−1

This diff is too big to show here.

test/command/din-1505-2.csldeleted−406

This diff is too big to show here.

test/command/docbook-bibliography.mddeleted−20

This diff is too big to show here.

test/command/duplicate_attributes.mddeleted−7

This diff is too big to show here.

test/command/emoji.mddeleted−27

This diff is too big to show here.

test/command/empty_paragraphs.md+2

This diff is too big to show here.

test/command/gfm.md+17−80

This diff is too big to show here.

test/command/harvard-university-of-kent.csldeleted−253

This diff is too big to show here.

test/command/hspace.md+3−3

This diff is too big to show here.

test/command/html-trim-definition-list-terms.mddeleted−17

This diff is too big to show here.

test/command/ieee.csldeleted−339

This diff is too big to show here.

test/command/ifstrequal.md+2−1

This diff is too big to show here.

test/command/issue160.csldeleted−28

This diff is too big to show here.

test/command/issue437.csldeleted−26

This diff is too big to show here.

test/command/issue58.csldeleted−553

This diff is too big to show here.

test/command/latex-center.mddeleted−13

This diff is too big to show here.

test/command/latex-tabular-column-specs.md+10−31

This diff is too big to show here.

test/command/le-tapuscrit-note.csldeleted−496

This diff is too big to show here.

test/command/lettrine.md+2−2

This diff is too big to show here.

test/command/lists-inside-definition.mddeleted−67

This diff is too big to show here.

test/command/locators.csldeleted−68

This diff is too big to show here.

test/command/lua-pandoc-state.luadeleted−11

This diff is too big to show here.

test/command/lua-pandoc-state.mddeleted−14

This diff is too big to show here.

test/command/macro-defs-in-preamble.mddeleted−16

This diff is too big to show here.

test/command/macros.md+9−34

This diff is too big to show here.

test/command/make-section-column-divs.mddeleted−28

This diff is too big to show here.

test/command/md-abbrevs.md+11

This diff is too big to show here.

test/command/mmd-metadata.mddeleted−20

This diff is too big to show here.

test/command/modern-humanities-research-association.csldeleted−445

This diff is too big to show here.

test/command/multiple-metadata-blocks.md+1−1

This diff is too big to show here.

test/command/nested-table-to-asciidoc-6942.mddeleted−82

This diff is too big to show here.

test/command/newif.mddeleted−55

This diff is too big to show here.

test/command/oscola.csldeleted−680

This diff is too big to show here.

test/command/pandoc-citeproc-118.mddeleted−28

This diff is too big to show here.

test/command/pandoc-citeproc-119.mddeleted−38

This diff is too big to show here.

test/command/pandoc-citeproc-13.mddeleted−29

This diff is too big to show here.

test/command/pandoc-citeproc-136.mddeleted−23

This diff is too big to show here.

test/command/pandoc-citeproc-14.mddeleted−77

This diff is too big to show here.

test/command/pandoc-citeproc-152.mddeleted−63

This diff is too big to show here.

test/command/pandoc-citeproc-160.mddeleted−44

This diff is too big to show here.

test/command/pandoc-citeproc-175.mddeleted−43

This diff is too big to show here.

test/command/pandoc-citeproc-197.mddeleted−31

This diff is too big to show here.

test/command/pandoc-citeproc-213.mddeleted−33

This diff is too big to show here.

test/command/pandoc-citeproc-25.mddeleted−30

This diff is too big to show here.

test/command/pandoc-citeproc-250.mddeleted−21

This diff is too big to show here.

test/command/pandoc-citeproc-27.mddeleted−38

This diff is too big to show here.

test/command/pandoc-citeproc-292.mddeleted−43

This diff is too big to show here.

test/command/pandoc-citeproc-301.mddeleted−25

This diff is too big to show here.

test/command/pandoc-citeproc-307.mddeleted−31

This diff is too big to show here.

test/command/pandoc-citeproc-31.mddeleted−48

This diff is too big to show here.

test/command/pandoc-citeproc-312.mddeleted−171

This diff is too big to show here.

test/command/pandoc-citeproc-320.mddeleted−254

This diff is too big to show here.

test/command/pandoc-citeproc-320a.mddeleted−87

This diff is too big to show here.

test/command/pandoc-citeproc-322.mddeleted−35

This diff is too big to show here.

test/command/pandoc-citeproc-325.mddeleted−30

This diff is too big to show here.

test/command/pandoc-citeproc-327.mddeleted−51

This diff is too big to show here.

test/command/pandoc-citeproc-338.mddeleted−35

This diff is too big to show here.

test/command/pandoc-citeproc-351.mddeleted−27

This diff is too big to show here.

test/command/pandoc-citeproc-356.mddeleted−20

This diff is too big to show here.

test/command/pandoc-citeproc-360.mddeleted−35

This diff is too big to show here.

test/command/pandoc-citeproc-361.mddeleted−80

This diff is too big to show here.

test/command/pandoc-citeproc-365.mddeleted−39

This diff is too big to show here.

test/command/pandoc-citeproc-371.mddeleted−40

This diff is too big to show here.

test/command/pandoc-citeproc-38.mddeleted−29

This diff is too big to show here.

test/command/pandoc-citeproc-386.mddeleted−35

This diff is too big to show here.

test/command/pandoc-citeproc-392.mddeleted−29

This diff is too big to show here.

test/command/pandoc-citeproc-399.mddeleted−45

This diff is too big to show here.

test/command/pandoc-citeproc-401.mddeleted−59

This diff is too big to show here.

test/command/pandoc-citeproc-408.mddeleted−39

This diff is too big to show here.

test/command/pandoc-citeproc-416.mddeleted−60

This diff is too big to show here.

test/command/pandoc-citeproc-437.mddeleted−23

This diff is too big to show here.

test/command/pandoc-citeproc-47.mddeleted−112

This diff is too big to show here.

test/command/pandoc-citeproc-51.mddeleted−45

This diff is too big to show here.

test/command/pandoc-citeproc-53.mddeleted−56

This diff is too big to show here.

test/command/pandoc-citeproc-57.mddeleted−37

This diff is too big to show here.

test/command/pandoc-citeproc-58.mddeleted−32

This diff is too big to show here.

test/command/pandoc-citeproc-61.mddeleted−77

This diff is too big to show here.

test/command/pandoc-citeproc-64.mddeleted−24

This diff is too big to show here.

test/command/pandoc-citeproc-65.mddeleted−38

This diff is too big to show here.

test/command/pandoc-citeproc-68.mddeleted−56

This diff is too big to show here.

test/command/pandoc-citeproc-7.mddeleted−31

This diff is too big to show here.

test/command/pandoc-citeproc-70.mddeleted−73

This diff is too big to show here.

test/command/pandoc-citeproc-75.mddeleted−67

This diff is too big to show here.

test/command/pandoc-citeproc-76.mddeleted−64

This diff is too big to show here.

test/command/pandoc-citeproc-77.mddeleted−67

This diff is too big to show here.

test/command/pandoc-citeproc-82.mddeleted−39

This diff is too big to show here.

test/command/pandoc-citeproc-87.mddeleted−156

This diff is too big to show here.

test/command/pandoc-citeproc-chicago-author-date.mddeleted−109

This diff is too big to show here.

test/command/pandoc-citeproc-chicago-fullnote-bibliography.mddeleted−134

This diff is too big to show here.

test/command/pandoc-citeproc-ieee.mddeleted−113

This diff is too big to show here.

test/command/pandoc-citeproc-locators-delimited.mddeleted−127

This diff is too big to show here.

test/command/pandoc-citeproc-locators-integrated.mddeleted−159

This diff is too big to show here.

test/command/pandoc-citeproc-move-period-inside-quote.mddeleted−52

This diff is too big to show here.

test/command/pandoc-citeproc-no-author.mddeleted−73

This diff is too big to show here.

test/command/pandoc-citeproc-number-of-volumes.mddeleted−29

This diff is too big to show here.

test/command/pandoc-citeproc-page-range.mddeleted−32

This diff is too big to show here.

test/command/parse-raw.md+2−2

This diff is too big to show here.

test/command/refs.md+2−45

This diff is too big to show here.

test/command/sage-harvard.csldeleted−202

This diff is too big to show here.

test/command/science.csldeleted−245

This diff is too big to show here.

test/command/section-divs.mddeleted−25

This diff is too big to show here.

test/command/setext-fenced-div.mddeleted−9

This diff is too big to show here.

test/command/shift-heading-level-by.mddeleted−32

This diff is too big to show here.

test/command/sloppypar.mddeleted−23

This diff is too big to show here.

test/command/style399.csldeleted−12

This diff is too big to show here.

test/command/svg.md+15−17

This diff is too big to show here.

test/command/table-with-cell-align.mddeleted−82

This diff is too big to show here.

test/command/table-with-column-span.mddeleted−276

This diff is too big to show here.

test/command/tabularx.md+48−123

This diff is too big to show here.

test/command/tasklist.mddeleted−113

This diff is too big to show here.

test/command/tex-group.mddeleted−12

This diff is too big to show here.

test/command/toc.mddeleted−47

This diff is too big to show here.

test/command/unicode-collation.mddeleted−130

This diff is too big to show here.

test/command/vancouver.csldeleted−351

This diff is too big to show here.

test/command/video-audio.mddeleted−19

This diff is too big to show here.

test/command/write18.md+1−1

This diff is too big to show here.

test/command/yaml-metadata-blocks.mddeleted−63

This diff is too big to show here.

test/command/yaml-metadata.yamldeleted−4

This diff is too big to show here.

test/command/zeitschrift-fur-kunstgeschichte.csl−346

This diff is too big to show here.

test/creole-reader.native+16−53

This diff is too big to show here.

test/docbook-chapter.docbook−30

This diff is too big to show here.

test/docbook-chapter.native−17

This diff is too big to show here.

test/docbook-reader.docbook+2−39

This diff is too big to show here.

test/docbook-reader.native+107−293

This diff is too big to show here.

test/docbook-xref.native+1−1

This diff is too big to show here.

test/docx/0_level_headers.native+14−41

This diff is too big to show here.

test/docx/adjacent_codeblocks.docx

This diff is too big to show here.

test/docx/adjacent_codeblocks.native−6

This diff is too big to show here.

test/docx/alternate_document_path.docx

This diff is too big to show here.

test/docx/alternate_document_path.native−3

This diff is too big to show here.

test/docx/block_quotes.docx

This diff is too big to show here.

test/docx/char_styles.docx

This diff is too big to show here.

test/docx/compact-style-removal.docx

This diff is too big to show here.

test/docx/compact-style-removal.native−5

This diff is too big to show here.

test/docx/custom-style-no-styles.native−4

This diff is too big to show here.

test/docx/custom-style-preserve.native−15

This diff is too big to show here.

test/docx/custom-style-roundtrip-start.native

This diff is too big to show here.

test/docx/custom-style-with-styles.native−7

This diff is too big to show here.

test/docx/deep_normalize.docx

This diff is too big to show here.

test/docx/document-properties-short-desc.native−2

This diff is too big to show here.

test/docx/document-properties.native−2

This diff is too big to show here.

test/docx/drop_cap.docx

This diff is too big to show here.

test/docx/golden/block_quotes.docx

This diff is too big to show here.

test/docx/golden/codeblock.docx

This diff is too big to show here.

test/docx/golden/comments.docx

This diff is too big to show here.

test/docx/golden/custom_style_no_reference.docx

This diff is too big to show here.

test/docx/golden/custom_style_preserve.docx

This diff is too big to show here.

test/docx/golden/custom_style_reference.docx

This diff is too big to show here.

test/docx/golden/definition_list.docx

This diff is too big to show here.

test/docx/golden/document-properties-short-desc.docx

This diff is too big to show here.

test/docx/golden/document-properties.docx

This diff is too big to show here.

test/docx/golden/headers.docx

This diff is too big to show here.

test/docx/golden/image.docx

This diff is too big to show here.

test/docx/golden/inline_code.docx

This diff is too big to show here.

test/docx/golden/inline_formatting.docx

This diff is too big to show here.

test/docx/golden/inline_images.docx

This diff is too big to show here.

test/docx/golden/link_in_notes.docx

This diff is too big to show here.

test/docx/golden/links.docx

This diff is too big to show here.

test/docx/golden/lists.docx

This diff is too big to show here.

test/docx/golden/lists_continuing.docx

This diff is too big to show here.

test/docx/golden/lists_multiple_initial.docx

This diff is too big to show here.

test/docx/golden/lists_restarting.docx

This diff is too big to show here.

test/docx/golden/nested_anchors_in_header.docx

This diff is too big to show here.

test/docx/golden/notes.docx

This diff is too big to show here.

test/docx/golden/raw-blocks.docx

This diff is too big to show here.

test/docx/golden/raw-bookmarks.docx

This diff is too big to show here.

test/docx/golden/table_one_row.docx

This diff is too big to show here.

test/docx/golden/table_with_list_cell.docx

This diff is too big to show here.

test/docx/golden/tables-default-widths.docx

This diff is too big to show here.

test/docx/golden/tables.docx

This diff is too big to show here.

test/docx/golden/track_changes_deletion.docx

This diff is too big to show here.

test/docx/golden/track_changes_insertion.docx

This diff is too big to show here.

test/docx/golden/track_changes_move.docx

This diff is too big to show here.

test/docx/golden/track_changes_scrubbed_metadata.docx

This diff is too big to show here.

test/docx/golden/unicode.docx

This diff is too big to show here.

test/docx/golden/verbatim_subsuper.docx

This diff is too big to show here.

test/docx/hanging_indent.docx

This diff is too big to show here.

test/docx/headers.docx

This diff is too big to show here.

test/docx/image_vml_as_object.docx

This diff is too big to show here.

test/docx/image_vml_as_object.native−2

This diff is too big to show here.

test/docx/image_writer_test.native−8

This diff is too big to show here.

test/docx/inline_formatting.docx

This diff is too big to show here.

test/docx/inline_formatting.native+1−2

This diff is too big to show here.

test/docx/inline_images.docx

This diff is too big to show here.

test/docx/inline_images_writer_test.native−2

This diff is too big to show here.

test/docx/instrText_hyperlink.docx

This diff is too big to show here.

test/docx/instrText_hyperlink.native−1

This diff is too big to show here.

test/docx/link_in_notes.docx

This diff is too big to show here.

test/docx/links.docx

This diff is too big to show here.

test/docx/lists-compact.docx

This diff is too big to show here.

test/docx/lists-compact.native−5

This diff is too big to show here.

test/docx/lists.docx

This diff is too big to show here.

test/docx/lists.native+1−1

This diff is too big to show here.

test/docx/lists_level_override.docx

This diff is too big to show here.

test/docx/lists_level_override.native−37

This diff is too big to show here.

test/docx/lists_multiple_initial.native−8

This diff is too big to show here.

test/docx/lists_sublist_reset.docx

This diff is too big to show here.

test/docx/lists_sublist_reset.native−8

This diff is too big to show here.

test/docx/metadata.docx

This diff is too big to show here.

test/docx/metadata_after_normal.docx

This diff is too big to show here.

test/docx/nested_anchors_in_header.native+1−6

This diff is too big to show here.

test/docx/nested_sdt.docx

This diff is too big to show here.

test/docx/nested_sdt.native−3

This diff is too big to show here.

test/docx/nested_smart_tags.docx

This diff is too big to show here.

test/docx/nested_smart_tags.native−7

This diff is too big to show here.

test/docx/normalize.docx

This diff is too big to show here.

test/docx/notes.docx

This diff is too big to show here.

test/docx/numbered_header.docx

This diff is too big to show here.

test/docx/overlapping_targets.docx

This diff is too big to show here.

test/docx/overlapping_targets.native−3

This diff is too big to show here.

test/docx/paragraph_insertion_deletion.docx

This diff is too big to show here.

test/docx/paragraph_insertion_deletion_accept.native−2

This diff is too big to show here.

test/docx/paragraph_insertion_deletion_all.native−3

This diff is too big to show here.

test/docx/paragraph_insertion_deletion_reject.native−2

This diff is too big to show here.

test/docx/raw-blocks.native−6

This diff is too big to show here.

test/docx/raw-bookmarks.native−3

This diff is too big to show here.

test/docx/sdt_elements.native+10−24

This diff is too big to show here.

test/docx/sdt_in_footnote.docx

This diff is too big to show here.

test/docx/sdt_in_footnote.native−1

This diff is too big to show here.

test/docx/table_captions_no_field.docx

This diff is too big to show here.

test/docx/table_captions_no_field.native−34

This diff is too big to show here.

test/docx/table_captions_with_field.docx

This diff is too big to show here.

test/docx/table_captions_with_field.native−54

This diff is too big to show here.

test/docx/table_header_rowspan.docx

This diff is too big to show here.

test/docx/table_header_rowspan.native−189

This diff is too big to show here.

test/docx/table_one_header_row.docx

This diff is too big to show here.

test/docx/table_one_header_row.native−18

This diff is too big to show here.

test/docx/table_one_row.docx

This diff is too big to show here.

test/docx/table_one_row.native+7−18

This diff is too big to show here.

test/docx/table_variable_width.docx

This diff is too big to show here.

test/docx/table_variable_width.native−40

This diff is too big to show here.

test/docx/table_with_list_cell.docx

This diff is too big to show here.

test/docx/table_with_list_cell.native+11−25

This diff is too big to show here.

test/docx/tables-default-widths.native−92

This diff is too big to show here.

test/docx/tables.docx

This diff is too big to show here.

test/docx/tables.native+35−91

This diff is too big to show here.

test/docx/track_changes_scrubbed_metadata.docx

This diff is too big to show here.

test/docx/track_changes_scrubbed_metadata.native−9

This diff is too big to show here.

test/docx/trim_last_inline.docx

This diff is too big to show here.

test/docx/trim_last_inline.native−2

This diff is too big to show here.

test/docx/unused_anchors.docx

This diff is too big to show here.

test/docx/unused_anchors.native−3

This diff is too big to show here.

test/dokuwiki_external_images.dokuwiki+1−1

This diff is too big to show here.

test/dokuwiki_multiblock_table.dokuwiki+3−4

This diff is too big to show here.

test/dokuwiki_multiblock_table.native+13−41

This diff is too big to show here.

test/epub/epub2_cover.epub

This diff is too big to show here.

test/epub/epub2_no_cover.epub

This diff is too big to show here.

test/epub/epub2_picture.epub

This diff is too big to show here.

test/epub/features.epub

This diff is too big to show here.

test/epub/features.native+3−3

This diff is too big to show here.

test/epub/img_no_cover.epub

This diff is too big to show here.

test/epub/wasteland.epub

This diff is too big to show here.

test/epub/wasteland.native+892−889

This diff is too big to show here.

test/fb2/basic.fb2+2−72

This diff is too big to show here.

test/fb2/images.fb2+1−1

This diff is too big to show here.

test/fb2/meta.fb2−3

This diff is too big to show here.

test/fb2/meta.markdown−7

This diff is too big to show here.

test/fb2/reader/emphasis.fb2−11

This diff is too big to show here.

test/fb2/reader/emphasis.native−6

This diff is too big to show here.

test/fb2/reader/epigraph.fb2−18

This diff is too big to show here.

test/fb2/reader/epigraph.native−9

This diff is too big to show here.

test/fb2/reader/meta.fb2−26

This diff is too big to show here.

test/fb2/reader/meta.native−2

This diff is too big to show here.

test/fb2/reader/notes.fb2−19

This diff is too big to show here.

test/fb2/reader/notes.native−4

This diff is too big to show here.

test/fb2/reader/poem.fb2−28

This diff is too big to show here.

test/fb2/reader/poem.native−14

This diff is too big to show here.

test/fb2/reader/titles.fb2−18

This diff is too big to show here.

test/fb2/reader/titles.native−8

This diff is too big to show here.

test/fb2/test.jpg

This diff is too big to show here.

test/fb2/titles.fb2+1−1

This diff is too big to show here.

test/fb2/titles.markdown+1−1

This diff is too big to show here.

test/html-reader.html−80

This diff is too big to show here.

test/html-reader.native+132−496

This diff is too big to show here.

test/ipynb/simple.in.native−15

This diff is too big to show here.

test/ipynb/simple.ipynb−86

This diff is too big to show here.

test/ipynb/simple.out.native−15

This diff is too big to show here.

test/jats-reader.native+133−382

This diff is too big to show here.

test/jats-reader.xml+980−356

This diff is too big to show here.

test/jira-reader.jira−284

This diff is too big to show here.

test/jira-reader.native−185

This diff is too big to show here.

test/latex-reader.latex+9−4

This diff is too big to show here.

test/latex-reader.native+24−65

This diff is too big to show here.

test/lhs-test-markdown.native+1−1

This diff is too big to show here.

test/lhs-test.html+73−205

This diff is too big to show here.

test/lhs-test.html+lhs+73−205

This diff is too big to show here.

test/lhs-test.latex+43−39

This diff is too big to show here.

test/lhs-test.latex+lhs+40−38

This diff is too big to show here.

test/lhs-test.markdown+1−1

This diff is too big to show here.

test/lhs-test.native+1−1

This diff is too big to show here.

test/lhs-test.rst+5−5

This diff is too big to show here.

test/lhs-test.rst+lhs+2−2

This diff is too big to show here.

test/lua/blocks-filter.lua−8

This diff is too big to show here.

test/lua/inlines-filter.lua−19

This diff is too big to show here.

test/lua/math.lua−10

This diff is too big to show here.

test/lua/meta.lua−6

This diff is too big to show here.

test/lua/module/pandoc-list.lua−160

This diff is too big to show here.

test/lua/module/pandoc-mediabag.lua−72

This diff is too big to show here.

test/lua/module/pandoc-path.lua−44

This diff is too big to show here.

test/lua/module/pandoc-types.lua−111

This diff is too big to show here.

test/lua/module/pandoc-utils.lua−159

This diff is too big to show here.

test/lua/module/pandoc.lua−253

This diff is too big to show here.

test/lua/require-file.lua−2

This diff is too big to show here.

test/lua/script-name.lua−3

This diff is too big to show here.

test/lua/smart-constructors.lua−10

This diff is too big to show here.

test/lua/test-pandoc-utils.lua+115

This diff is too big to show here.

test/man-reader.man−391

This diff is too big to show here.

test/man-reader.native−300

This diff is too big to show here.

test/markdown-citations.native+14−14

This diff is too big to show here.

test/markdown-reader-more.native+79−194

This diff is too big to show here.

test/mediawiki-reader.native+85−241

This diff is too big to show here.

test/odt/markdown/formula.md−1

This diff is too big to show here.

test/odt/native/simpleTable.native+1−1

This diff is too big to show here.

test/odt/native/simpleTableWithCaption.native+1−1

This diff is too big to show here.

test/odt/native/tab.native−1

This diff is too big to show here.

test/odt/native/tableWithContents.native+1−1

This diff is too big to show here.

test/odt/odt/tab.odt

This diff is too big to show here.

test/org-select-tags.native−7

This diff is too big to show here.

test/org-select-tags.org−17

This diff is too big to show here.

test/pipe-tables.native+104−315

This diff is too big to show here.

test/pptx/code-custom.pptx

This diff is too big to show here.

test/pptx/code-custom_templated.pptx

This diff is too big to show here.

test/pptx/code.native−21

This diff is too big to show here.

test/pptx/code.pptx

This diff is too big to show here.

test/pptx/code_templated.pptx

This diff is too big to show here.

test/pptx/document-properties-short-desc.native−2

This diff is too big to show here.

test/pptx/document-properties-short-desc.pptx

This diff is too big to show here.

test/pptx/document-properties-short-desc_templated.pptx

This diff is too big to show here.

test/pptx/document-properties.native−2

This diff is too big to show here.

test/pptx/document-properties.pptx

This diff is too big to show here.

test/pptx/document-properties_templated.pptx

This diff is too big to show here.

test/pptx/endnotes.native−2

This diff is too big to show here.

test/pptx/endnotes.pptx

This diff is too big to show here.

test/pptx/endnotes_templated.pptx

This diff is too big to show here.

test/pptx/endnotes_toc.pptx

This diff is too big to show here.

test/pptx/endnotes_toc_templated.pptx

This diff is too big to show here.

test/pptx/images.native−5

This diff is too big to show here.

test/pptx/images.pptx

This diff is too big to show here.

test/pptx/images_templated.pptx

This diff is too big to show here.

test/pptx/inline_formatting.native−5

This diff is too big to show here.

test/pptx/inline_formatting.pptx

This diff is too big to show here.

test/pptx/inline_formatting_templated.pptx

This diff is too big to show here.

test/pptx/lists.native−18

This diff is too big to show here.

test/pptx/lists.pptx

This diff is too big to show here.

test/pptx/lists_templated.pptx

This diff is too big to show here.

test/pptx/raw_ooxml.native−3

This diff is too big to show here.

test/pptx/raw_ooxml.pptx

This diff is too big to show here.

test/pptx/raw_ooxml_templated.pptx

This diff is too big to show here.

test/pptx/reference_depth.pptx

This diff is too big to show here.

test/pptx/remove_empty_slides.native−5

This diff is too big to show here.

test/pptx/remove_empty_slides.pptx

This diff is too big to show here.

test/pptx/remove_empty_slides_templated.pptx

This diff is too big to show here.

test/pptx/slide_breaks.native−7

This diff is too big to show here.

test/pptx/slide_breaks.pptx

This diff is too big to show here.

test/pptx/slide_breaks_slide_level_1.pptx

This diff is too big to show here.

test/pptx/slide_breaks_slide_level_1_templated.pptx

This diff is too big to show here.

test/pptx/slide_breaks_templated.pptx

This diff is too big to show here.

test/pptx/slide_breaks_toc.pptx

This diff is too big to show here.

test/pptx/slide_breaks_toc_templated.pptx

This diff is too big to show here.

test/pptx/speaker_notes.native−17

This diff is too big to show here.

test/pptx/speaker_notes.pptx

This diff is too big to show here.

test/pptx/speaker_notes_after_metadata.native−5

This diff is too big to show here.

test/pptx/speaker_notes_after_metadata.pptx

This diff is too big to show here.

test/pptx/speaker_notes_after_metadata_templated.pptx

This diff is too big to show here.

test/pptx/speaker_notes_afterheader.native−3

This diff is too big to show here.

test/pptx/speaker_notes_afterheader.pptx

This diff is too big to show here.

test/pptx/speaker_notes_afterheader_templated.pptx

This diff is too big to show here.

test/pptx/speaker_notes_afterseps.native−63

This diff is too big to show here.

test/pptx/speaker_notes_afterseps.pptx

This diff is too big to show here.

test/pptx/speaker_notes_afterseps_templated.pptx

This diff is too big to show here.

test/pptx/speaker_notes_templated.pptx

This diff is too big to show here.

test/pptx/start_numbering_at.native−9

This diff is too big to show here.

test/pptx/start_numbering_at.pptx

This diff is too big to show here.

test/pptx/start_numbering_at_templated.pptx

This diff is too big to show here.

test/pptx/tables.native−95

This diff is too big to show here.

test/pptx/tables.pptx

This diff is too big to show here.

test/pptx/tables_templated.pptx

This diff is too big to show here.

test/pptx/two_column.native−9

This diff is too big to show here.

test/pptx/two_column.pptx

This diff is too big to show here.

test/pptx/two_column_templated.pptx

This diff is too big to show here.

test/rst-reader.native+72−180

This diff is too big to show here.

test/rst-reader.rst+1−25

This diff is too big to show here.

test/s5-basic.html+4−7

This diff is too big to show here.

test/s5-fancy.html+206−8

This diff is too big to show here.

test/s5-inserts.html+4−7

This diff is too big to show here.

test/tables-rstsubset.native+107−294

This diff is too big to show here.

test/tables.asciidoc+17−17

This diff is too big to show here.

test/tables.asciidoctor−67

This diff is too big to show here.

test/tables.context+155−210

This diff is too big to show here.

test/tables.custom+11−10

This diff is too big to show here.

test/tables.docbook4+3−3

This diff is too big to show here.

test/tables.docbook5+3−3

This diff is too big to show here.

test/tables.dokuwiki+1

This diff is too big to show here.

test/tables.fb2+2−14

This diff is too big to show here.

test/tables.haddock+56−70

This diff is too big to show here.

test/tables.html4+6−6

This diff is too big to show here.

test/tables.html5+6−6

This diff is too big to show here.

test/tables.icml+3−3

This diff is too big to show here.

test/tables.jats+430

This diff is too big to show here.

test/tables.jats_archiving−226

This diff is too big to show here.

test/tables.jats_articleauthoring−226

This diff is too big to show here.

test/tables.jats_publishing−226

This diff is too big to show here.

test/tables.jira−43

This diff is too big to show here.

test/tables.latex+101−65

This diff is too big to show here.

test/tables.man+7−7

This diff is too big to show here.

test/tables.mediawiki+4−3

This diff is too big to show here.

test/tables.ms+7−51

This diff is too big to show here.

test/tables.muse+11−24

This diff is too big to show here.

test/tables.native+107−286

This diff is too big to show here.

test/tables.opendocument+96−98

This diff is too big to show here.

test/tables.org+31−31

This diff is too big to show here.

test/tables.rst+64−56

This diff is too big to show here.

test/tables.rtf+9−8

This diff is too big to show here.

test/tables.tei+12

This diff is too big to show here.

test/tables.texinfo+3−3

This diff is too big to show here.

test/tables.textile+4−3

This diff is too big to show here.

test/tables.txt+1

This diff is too big to show here.

test/tables.xwiki−45

This diff is too big to show here.

test/tables.zimwiki+1

This diff is too big to show here.

test/tables/nordics.html4−59

This diff is too big to show here.

test/tables/nordics.html5−59

This diff is too big to show here.

test/tables/nordics.jats_archiving−58

This diff is too big to show here.

test/tables/nordics.latex−42

This diff is too big to show here.

test/tables/nordics.native−73

This diff is too big to show here.

test/tables/planets.html4−133

This diff is too big to show here.

test/tables/planets.html5−133

This diff is too big to show here.

test/tables/planets.jats_archiving−128

This diff is too big to show here.

test/tables/planets.latex−30

This diff is too big to show here.

test/tables/planets.native−241

This diff is too big to show here.

test/tables/students.html4−55

This diff is too big to show here.

test/tables/students.html5−55

This diff is too big to show here.

test/tables/students.jats_archiving−56

This diff is too big to show here.

test/tables/students.latex−31

This diff is too big to show here.

test/tables/students.native−54

This diff is too big to show here.

test/test-pandoc.hs+5−40

This diff is too big to show here.

test/testsuite.native+6−6

This diff is too big to show here.

test/textile-reader.native+42−105

This diff is too big to show here.

test/textile-reader.textile+2−2

This diff is too big to show here.

test/tikiwiki-reader.native+67−149

This diff is too big to show here.

test/twiki-reader.native+34−110

This diff is too big to show here.

test/txt2tags.native+304−661

This diff is too big to show here.

test/txt2tags.t2t+2−2

This diff is too big to show here.

test/vimwiki-reader.native+76−216

This diff is too big to show here.

test/vimwiki-reader.wiki+1−12

This diff is too big to show here.

test/writer.asciidoc+149−108

This diff is too big to show here.

test/writer.asciidoctor−649

This diff is too big to show here.

test/writer.context+79−97

This diff is too big to show here.

test/writer.custom+12−11

This diff is too big to show here.

test/writer.docbook4+1266−1272

This diff is too big to show here.

test/writer.docbook5+1230−1237

This diff is too big to show here.

test/writer.dokuwiki+3−14

This diff is too big to show here.

test/writer.fb2+401−144

This diff is too big to show here.

test/writer.haddock+7−8

This diff is too big to show here.

test/writer.html4+14−147

This diff is too big to show here.

test/writer.html5+21−154

This diff is too big to show here.

test/writer.icml+161−92

This diff is too big to show here.

test/writer.jats+1448

This diff is too big to show here.

test/writer.jats_archiving−902

This diff is too big to show here.

test/writer.jats_articleauthoring−874

This diff is too big to show here.

test/writer.jats_publishing−902

This diff is too big to show here.

test/writer.jira−537

This diff is too big to show here.

test/writer.latex+60−59

This diff is too big to show here.

test/writer.man+161−124

This diff is too big to show here.

test/writer.markdown+57−77

This diff is too big to show here.

test/writer.mediawiki+2−2

This diff is too big to show here.

test/writer.ms+124−130

This diff is too big to show here.

test/writer.muse+67−61

This diff is too big to show here.

test/writer.native+6−6

This diff is too big to show here.

test/writer.opendocument+236−625

This diff is too big to show here.

test/writer.opml+2−2

This diff is too big to show here.

test/writer.org+142−116

This diff is too big to show here.

test/writer.plain+89−36

This diff is too big to show here.

test/writer.rst+140−82

This diff is too big to show here.

test/writer.rtf+1−1

This diff is too big to show here.

test/writer.tei+33−33

This diff is too big to show here.

test/writer.texinfo+22−11

This diff is too big to show here.

test/writer.textile+9−9

This diff is too big to show here.

test/writer.xwiki−650

This diff is too big to show here.

test/writer.zimwiki+93−93

This diff is too big to show here.

test/writers-lang-and-dir.context+17−25

This diff is too big to show here.

test/writers-lang-and-dir.latex+57−58

This diff is too big to show here.

tools/build-arm.sh−110

This diff is too big to show here.

tools/changelog-helper.sh−30

This diff is too big to show here.

tools/changes_template.html−6

This diff is too big to show here.

tools/diff-zip.sh−33

This diff is too big to show here.

tools/extract-changes.hs+3−9

This diff is too big to show here.

tools/ldoc.ltp+38

This diff is too big to show here.

tools/parseTimings.pl−33

This diff is too big to show here.

tools/update-lua-docs.lua+47

This diff is too big to show here.

tools/update-readme.lua−28

This diff is too big to show here.

trypandoc/index.html+22−51

This diff is too big to show here.

trypandoc/trypandoc.hs+11−21

This diff is too big to show here.

windows/Makefile−10

This diff is too big to show here.

windows/Pandoc-en-us.wxl+1−1

This diff is too big to show here.

windows/make-windows-installer.bat+29

This diff is too big to show here.

windows/pandoc.wxs+7−5

This diff is too big to show here.