Tissevert/pandoc
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1
No description
13005 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
Albert Krewinkel 2c13773be8
Jira writer: use jira-wiki-markup renderer 
Pandoc's AST is translated into the Jira AST, which is then rendered by
the dedicated Jira printer.

The following improvements are included in this change:

- non-jira raw blocks are fully discarded instead of showing as blank
  lines;
- table cells can contain multiple blocks;
- unnecessary blank lines are removed from the output;
- markup chars within words are properly surrounded by braces;
- preserving soft linebreaks via `--wrap=preserve` is supported.

Note that backslashes are rendered as HTML entities, as there appears no
alternative to produce a plain backslash if it is followed by markup.
This may cause problems when used with confluence, where rendering seems
to fail in this case.

Closes: #5926
2019-12-20 17:12:46 +01:00
.circleci Comment out ghc 8.8.1 build for now. 2019-08-26 18:12:59 -07:00
.github ci: remove quotes around --hide-successes. 2019-11-30 21:21:42 -08:00
benchmark Switch to new pandoc-types and use Text instead of String [API change]. 2019-11-12 16:03:45 -08:00
data ConTeXt template: Adjustments to title formatting (#5949) 2019-12-11 08:28:11 -08:00
doc lua-filters.md remove spurious dot in title (#5996) 2019-12-17 10:01:42 -08:00
linux linux tarball: add architecture -amd64 to filename. 2019-10-04 22:00:17 -07:00
macos Removed stack.pkg.yaml. 2017-12-27 20:21:37 -08:00
man Regenerate man page. 2019-12-11 21:03:29 -08:00
prelude New approach to custom Prelude. 2018-03-18 09:20:21 -07:00
src/Text Jira writer: use jira-wiki-markup renderer 2019-12-20 17:12:46 +01:00
test Jira writer: use jira-wiki-markup renderer 2019-12-20 17:12:46 +01:00
tools Fix README.md so that relative links from manual become absolute. 2019-12-10 14:46:33 -08:00
trypandoc Fix trypandoc for Text changes. 2019-11-22 09:45:10 -08:00
windows Improve Makefile for signing windows release candidates. 2019-11-29 22:02:04 -08: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 Use HsYAML-0.2.0.0 2019-09-22 10:38:15 -07:00
.hlint.yaml Add .hlint.yaml 2017-10-29 13:08:22 -07: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 changelog. 2019-12-11 11:02:50 -08:00
BUGS BUGS: Added reference to CONTRIBUTING.md. 2013-04-14 22:14:44 -07:00
cabal.project Use pandoc-citeproc 0.16.4.1 (cabal). 2019-12-11 19:19:20 -08:00
changelog.md Provisional changelog. 2019-12-17 12:19:10 -08:00
CONTRIBUTING.md Add info about command test naming to CONTRIBUTING 2019-10-16 09:09:08 -07: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 Use external emojis package. 2019-12-08 17:27:18 -08:00
INSTALL.md Add Void Linux 2019-10-15 14:50:32 -07:00
Makefile Use external emojis package. 2019-12-08 17:27:18 -08:00
MANUAL.txt Add jira reader (#5913) 2019-12-17 21:07:46 -08:00
pandoc.cabal pandoc.cabal: remove redundancies in extra-source-files 2019-12-18 08:05:19 +01:00
pandoc.hs Remove license boilerplate (pandoc.hs). 2019-03-01 10:29:23 -08:00
README.md Fix README.md so that relative links from manual become absolute. 2019-12-10 14:46:33 -08:00
README.template Remove appveyor.yml. 2019-10-13 16:54:19 -07:00
RELEASE-CHECKLIST Slight tweak to RELEASE_CHECKLIST 2019-12-05 12:40:17 -08:00
Setup.hs Removed custom Setup.hs, use build-type: simple. 2019-01-02 17:02:02 -08:00
stack.yaml Add jira reader (#5913) 2019-12-17 21:07:46 -08:00

README.md

Pandoc

github release hackage release homebrew stackage LTS package CircleCI 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-2018 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.)