No description
Find a file
John MacFarlane c8b906256d Improved behavior of auto_identifiers when there are explicit ids.
Previously only autogenerated ids were added to the list
of header identifiers in state, so explicit ids weren't taken
into account when generating unique identifiers.  Duplicated
identifiers could result.

This simple fix ensures that explicitly given identifiers are
also taken into account.

Fixes #1745.

Note some limitations, however.  An autogenerated identifier
may still coincide with an explicit identifier that is given
for a header later in the document, or with an identifier on
a div, span, link, or image.  Fixing this would be much more
difficult, because we need to run `registerHeader` before
we have the complete parse tree (so we can't get a complete
list of identifiers from the document by walking the tree).

However, it might be worth issuing warnings for duplicate
header identifiers; I think we can do that.  It is not
common for headers to have the same text, and the issue
can always be worked around by adding explicit identifiers,
if the user is aware of it.
2017-03-12 21:30:04 +01:00
benchmark Fix stale references to tests directory (#3469) 2017-02-25 10:31:40 +01:00
data Add Muse writer (#3489) 2017-03-10 10:16:27 +01:00
deb Add Muse writer (#3489) 2017-03-10 10:16:27 +01:00
doc Added skeletons for docs on customizing pandoc and using pandoc API. 2017-02-01 12:50:44 +01:00
lib/fonts lib: Added symbol.txt and file to generate codepoint to unicode mapping 2014-08-09 22:37:12 -04:00
macos Replaced {deb,macos,windows}/stack.yaml with stack.pkg.yaml. 2017-02-12 21:45:30 +01:00
man Updated man page. 2017-01-29 21:19:16 +01:00
prelude Remove unnecessary CPP in custom Prelude. 2016-09-03 15:23:32 -04:00
src/Text Improved behavior of auto_identifiers when there are explicit ids. 2017-03-12 21:30:04 +01:00
test Improved behavior of auto_identifiers when there are explicit ids. 2017-03-12 21:30:04 +01:00
tools Makefile: Separate refactor and reformat targets. 2017-03-04 13:13:12 +01:00
trypandoc Add Muse writer (#3489) 2017-03-10 10:16:27 +01:00
windows Windows packaging fixes to use new stack.pkg.yaml. 2017-02-12 22:04:53 +01:00
.editorconfig Fix editorconfig for test files 2014-04-12 12:22:09 +02:00
.gitignore Added deb/.vagrant to gitignore 2017-02-01 12:36:56 +01:00
.stylish-haskell.yaml Added 'make refactor' using hlint, stylish-haskell. 2017-03-04 12:49:14 +01:00
.travis.yml Travis: Remove GHC HEAD build. 2017-03-08 12:57:49 +01:00
appveyor.yml appveyor.yml: Fixed some paths. 2017-02-12 23:17:35 +01:00
BUGS BUGS: Added reference to CONTRIBUTING.md. 2013-04-14 22:14:44 -07:00
changelog Updated changelog. 2017-01-29 21:09:21 +01:00
CONTRIBUTING.md Fixed typos in CONTRIBUTING.md (#3479) 2017-03-01 15:00:53 +01:00
COPYING.md Download markdown version of the license from GNU and rename to COPYING.md 2016-10-19 04:11:36 -07:00
COPYRIGHT Fix stale references to tests directory (#3469) 2017-02-25 10:31:40 +01:00
INSTALL.md Fix stale references to tests directory (#3469) 2017-02-25 10:31:40 +01:00
Makefile Makefile - removed 'refactor' target. 2017-03-04 13:40:02 +01:00
MANUAL.txt MANUAL: Small clarification in YAML metadata section. 2017-03-12 10:08:34 +01:00
pandoc.cabal Add Muse writer (#3489) 2017-03-10 10:16:27 +01:00
pandoc.hs Stylish-haskell automatic formatting changes. 2017-03-04 13:03:41 +01:00
README.md Add Muse writer (#3489) 2017-03-10 10:16:27 +01:00
RELEASE-CHECKLIST Update RELEASE_CHECKLIST. 2017-02-27 10:19:22 +01:00
RELEASE-CHECKLIST.md Updated RELEASE-CHECKLIST and markdownified. 2017-01-25 17:07:41 +01:00
Setup.hs Setup.hs - removed some unneeded imports. 2016-10-18 15:11:05 +02:00
stack.full.yaml Use lts-7.5 resolver. 2016-10-26 12:32:30 +02:00
stack.pkg.yaml stack.yaml: Use texmath 0.9.3. 2017-03-10 10:15:39 +01:00
stack.yaml stack.yaml: Use texmath 0.9.3. 2017-03-10 10:15:39 +01:00

Pandoc

github release hackage release homebrew stackage LTS package travis build status appveyor build status 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 read Markdown, CommonMark, PHP Markdown Extra, GitHub-Flavored Markdown, MultiMarkdown, and (subsets of) Textile, reStructuredText, HTML, LaTeX, MediaWiki markup, TWiki markup, Haddock markup, OPML, Emacs Org mode, DocBook, txt2tags, EPUB, ODT and Word docx; and it can write plain text, Markdown, CommonMark, PHP Markdown Extra, GitHub-Flavored Markdown, MultiMarkdown, reStructuredText, XHTML, HTML5, LaTeX including [`beamer`] slide shows, ConTeXt, RTF, OPML, DocBook, OpenDocument, ODT, Word docx, GNU Texinfo, MediaWiki markup, DokuWiki markup, ZimWiki markup, Haddock markup, EPUB v2 or v3, FictionBook2, Textile, groff man pages, Emacs Org mode, AsciiDoc, InDesign ICML, TEI Simple, Muse, and Slidy, Slideous, DZSlides, reveal.js or S5 HTML slide shows. It can also produce PDF output on systems where LaTeX, ConTeXt, or wkhtmltopdf is installed.

Pandoc's enhanced version of Markdown includes syntax for footnotes, tables, flexible ordered lists, definition lists, fenced code blocks, superscripts and subscripts, strikeout, metadata blocks, automatic tables of contents, embedded LaTeX math, citations, and Markdown inside HTML block elements. (These enhancements, described further under Pandoc's Markdown, can be disabled using the markdown_strict input or output format.)

In contrast to most existing tools for converting Markdown to HTML, which use regex substitutions, 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, 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.

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-2016 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.)