Tissevert/pandoc
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1
No description
14019 commits 2 branches 0 tags 65 MiB
Haskell 87.8%
Rich Text Format 6.2%
HTML 1.8%
Lua 1.6%
Roff 0.9%
Other 1.4%
Find a file
John MacFarlane 2415b2680a Test suite: a more robust way of testing the executable. 
Mmny of our tests require running the pandoc
executable. This is problematic for a few different reasons.
First, cabal-install will sometimes run the test suite
after building the library but before building the executable,
which means the executable isn't in place for the tests.
One can work around that by first building, then building
and running the tests, but that's fragile.  Second,
we have to find the executable. So far, we've done that
using a function findPandoc that attempts to locate it
relative to the test executable (which can be located
using findExecutablePath).  But the logic here is delicate
and work with every combination of options.

To solve both problems, we add an `--emulate` option to
the `test-pandoc` executable.  When `--emulate` occurs
as the first argument passed to `test-pandoc`, the
program simply emulates the regular pandoc executable,
using the rest of the arguments (after `--emulate`).
Thus,

    test-pandoc --emulate -f markdown -t latex

is just like

    pandoc -f markdown -t latex

Since all the work is done by library functions,
implementing this emulation just takes a couple lines
of code and should be entirely reliable.

With this change, we can test the pandoc executable
by running the test program itself (locatable using
findExecutablePath) with the `--emulate` option.
This removes the need for the fragile `findPandoc`
step, and it means we can run our integration tests
even when we're just building the library, not the
executable.

Part of this change involved simplifying some complex
handling to set environment variables for dynamic
library paths.  I have tested a build with
`--enable-dynamic-executable`, and it works, but
further testing may be needed.
2021-02-02 20:36:51 -08:00
.circleci CircleCI: fix stack installation. 2020-12-29 15:41:18 -08:00
.github Improve check target to test data/ too. 2020-12-18 12:05:24 -08:00
app Update copyright notices for 2021 (#7012) 2021-01-08 09:38:20 -08:00
benchmark Remove superfluous import 2021-02-02 14:46:59 -08:00
citeproc/biblatex-localization Add built-in citation support using new citeproc library. 2020-09-21 10:15:50 -07:00
data Add default.bibtex to repository. 2021-02-01 18:53:59 -08:00
doc JATS templates: tag author.name as string-name 2021-01-29 09:51:20 +01:00
linux Re-add -optc-Os to static linux build, because it makes binary smaller. 2020-11-18 19:02:04 -08:00
macos Add built-in citation support using new citeproc library. 2020-09-21 10:15:50 -07:00
man Update README and man page. 2021-01-22 21:37:59 -08:00
prelude Use implicit Prelude (#6187) 2020-03-15 09:45:44 -07:00
src/Text Add parseOptionsFromArgs [API change, addition]. 2021-02-02 17:00:03 -08:00
test Test suite: a more robust way of testing the executable. 2021-02-02 20:36:51 -08:00
tools make changes_github: use details tag to make changelog collapsible. 2020-03-15 11:23:55 -07:00
trypandoc Update copyright notices for 2021 (#7012) 2021-01-08 09:38:20 -08:00
windows Add built-in citation support using new citeproc library. 2020-09-21 10:15:50 -07:00
.editorconfig .editorconfig: change tests/ to test/ as in 18ab864 2017-10-26 22:34:36 -07:00
.gitattributes Added .gitattributes. 2019-09-15 10:40:59 -07:00
.gitignore Improve .gitignore. 2021-01-15 22:41:39 -08:00
.hlint.yaml Undo the "Use fromRight" hlint hint. 2020-12-30 16:04:09 -08:00
.mailmap Add .mailmap 2019-01-07 08:44:40 +03:00
.stylish-haskell.yaml More spellcheck 2018-07-02 19:07:28 +03:00
AUTHORS.md Update AUTHORS.md. 2021-01-23 15:54:38 -08:00
BUGS
cabal.project cabal.project - more heap space 2021-02-02 14:47:27 -08:00
changelog.md Update changelog. 2021-01-22 21:37:04 -08:00
CONTRIBUTING.md CONTRIBUTING: note on GNU xargs 2021-01-12 21:53:39 -08:00
COPYING.md
COPYRIGHT JATS writer: fix citations (#7018) 2021-01-10 15:35:48 -08:00
default.nix Use simple default.nix. 2021-01-13 09:52:09 -08:00
INSTALL.md INSTALL.md: Remove references to pandoc-citeproc. 2020-11-19 09:40:46 -08:00
Makefile Makefile: give allocation data in benchmarks. 2021-01-31 18:18:53 -08:00
MANUAL.txt Improve docs for cite-method. 2021-01-27 09:22:50 -08:00
pandoc.cabal BibTeX writer: use doclayout and doctemplate. 2021-02-01 18:05:20 -08:00
README.md Update README and man page. 2021-01-22 21:37:59 -08:00
README.template Update copyright notices for 2021 (#7012) 2021-01-08 09:38:20 -08:00
RELEASE-CHECKLIST Update RELEASE-CHECKLIST for CircleCI. 2020-12-17 23:47:25 -08:00
release.nix Use project.nix instead of default.nix for generated file. 2021-01-12 22:32:26 -08:00
Setup.hs Removed custom Setup.hs, use build-type: simple. 2019-01-02 17:02:02 -08:00
shell.nix shell.nix - install zlib 2021-02-02 14:47:14 -08:00
stack.yaml BibTeX writer fixes. Closes #7067. 2021-02-01 11:23:07 -08:00

README.md

Pandoc

github release hackage release homebrew stackage LTS package CI tests license pandoc-discuss on google groups

The universal markup converter

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

It can convert to

Pandoc can also produce PDF output via LaTeX, Groff ms, or HTML.

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

Pandoc has a modular design: it consists of a set of readers, which parse text in a given format and produce a native representation of the document (an abstract syntax tree or AST), and a set of writers, which convert this native representation into a target format. Thus, adding an input or output format requires only adding a reader or writer. Users can also run custom pandoc filters to modify the intermediate AST (see the documentation for filters and Lua filters).

Because pandoc’s intermediate representation of a document is less expressive than many of the formats it converts between, one should not expect perfect conversions between every format and every other. Pandoc attempts to preserve the structural elements of a document, but not formatting details such as margin size. And some document elements, such as complex tables, may not fit into pandoc’s simple document model. While conversions from pandoc’s Markdown to all formats aspire to be perfect, conversions from formats more expressive than pandoc’s Markdown can be expected to be lossy.

Installing

Here’s how to install pandoc.

Documentation

Pandoc’s website contains a full User’s Guide. It is also available here as pandoc-flavored Markdown. The website also contains some examples of the use of pandoc and a limited online demo.

Contributing

Pull requests, bug reports, and feature requests are welcome. Please make sure to read the contributor guidelines before opening a new issue.

License

© 2006-2021 John MacFarlane (jgm@berkeley.edu). Released under the GPL, version 2 or greater. This software carries no warranty of any kind. (See COPYRIGHT for full copyright and warranty notices.)