@@ -2,167 +2,150 @@
22README.template and MANUAL.txt via the command:
33pandoc --lua-filter tools/update-readme.lua README.template -o README.md
44-->
5−Pandoc
6−======
7−
8−[![github release][]][] [![hackage release][]][] [![homebrew][]][]
9−[![stackage LTS package][]][] [![travis build status][]][] [![appveyor
10−build status][]][] [![license][]][] [![pandoc-discuss on google groups]]
11−
12− [github release]: https://img.shields.io/github/release/jgm/pandoc.svg?label=current+release
13− [![github release][]]: https://github.com/jgm/pandoc/releases
14− [hackage release]: https://img.shields.io/hackage/v/pandoc.svg?label=hackage
15− [![hackage release][]]: http://hackage.haskell.org/package/pandoc
16− [homebrew]: https://img.shields.io/homebrew/v/pandoc.svg
17− [![homebrew][]]: http://brewformulas.org/Pandoc
18− [stackage LTS package]: http://stackage.org/package/pandoc/badge/lts
19− [![stackage LTS package][]]: http://stackage.org/lts/package/pandoc
20− [travis build status]: https://img.shields.io/travis/jgm/pandoc/master.svg?label=travis+build
21− [![travis build status][]]: https://travis-ci.org/jgm/pandoc
22− [appveyor build status]: https://ci.appveyor.com/api/projects/status/nvqs4ct090igjiqc?svg=true
23− [![appveyor build status][]]: https://ci.appveyor.com/project/jgm/pandoc
24− [license]: https://img.shields.io/badge/license-GPLv2+-lightgray.svg
25− [![license][]]: https://www.gnu.org/licenses/gpl.html
26− [pandoc-discuss on google groups]: https://img.shields.io/badge/pandoc-discuss-red.svg?style=social
27− [![pandoc-discuss on google groups]]: https://groups.google.com/forum/#!forum/pandoc-discuss
28−
29−The universal markup converter
30−------------------------------
31−
32−::: {#description}
33−Pandoc is a [Haskell] library for converting from one markup format to
34−another, and a command-line tool that uses this library.
35−
36−Pandoc can read [Markdown], [CommonMark], [PHP Markdown Extra],
37−[GitHub-Flavored Markdown], [MultiMarkdown], and (subsets of) [Textile],
38−[reStructuredText], [HTML], [LaTeX], [MediaWiki markup], [TWiki markup],
39−[TikiWiki markup], [Creole 1.0], [Haddock markup], [OPML], [Emacs Org
40−mode], [DocBook], [JATS], [Muse], [txt2tags], [Vimwiki], [EPUB], [ODT],
41−and [Word docx].
42−
43−Pandoc can write plain text, [Markdown], [CommonMark], [PHP Markdown
44−Extra], [GitHub-Flavored Markdown], [MultiMarkdown], [reStructuredText],
45−[XHTML], [HTML5], [LaTeX] (including [`beamer`] slide shows), [ConTeXt],
46−[RTF], [OPML], [DocBook], [JATS], [OpenDocument], [ODT], [Word docx],
47−[GNU Texinfo], [MediaWiki markup], [DokuWiki markup], [ZimWiki markup],
48−[Haddock markup], [EPUB] (v2 or v3), [FictionBook2], [Textile], [groff
49−man], [groff ms], [Emacs Org mode], [AsciiDoc], [InDesign ICML], [TEI
50−Simple], [Muse], [PowerPoint] slide shows and [Slidy], [Slideous],
51−[DZSlides], [reveal.js] or [S5] HTML slide shows. It can also produce
52−[PDF] output on systems where LaTeX, ConTeXt, `pdfroff`, `wkhtmltopdf`,
53−`prince`, or `weasyprint` is installed.
54−
55−Pandoc's enhanced version of Markdown includes syntax for tables,
5+
6+# Pandoc
7+
8+[](https://github.com/jgm/pandoc/releases)
10+[](http://hackage.haskell.org/package/pandoc)
12+[](http://brewformulas.org/Pandoc)
13+[](http://stackage.org/lts/package/pandoc)
15+[](https://travis-ci.org/jgm/pandoc)
17+[](https://ci.appveyor.com/project/jgm/pandoc)
19+[](https://www.gnu.org/licenses/gpl.html)
20+[](https://groups.google.com/forum/#!forum/pandoc-discuss)
22+
23+## The universal markup converter
24+
25+<div id="description">
26+
27+Pandoc is a [Haskell](https://www.haskell.org) library for converting
28+from one markup format to another, and a command-line tool that uses
29+this library.
30+
31+Pandoc can read
32+[Markdown](http://daringfireball.net/projects/markdown/),
33+[CommonMark](http://commonmark.org), [PHP Markdown
34+Extra](https://michelf.ca/projects/php-markdown/extra/),
35+[GitHub-Flavored
36+Markdown](https://help.github.com/articles/github-flavored-markdown/),
37+[MultiMarkdown](http://fletcherpenney.net/multimarkdown/), and (subsets
38+of) [Textile](http://redcloth.org/textile),
39+[reStructuredText](http://docutils.sourceforge.net/docs/ref/rst/introduction.html),
40+[HTML](http://www.w3.org/html/), [LaTeX](http://latex-project.org),
41+[MediaWiki markup](https://www.mediawiki.org/wiki/Help:Formatting),
42+[TWiki markup](http://twiki.org/cgi-bin/view/TWiki/TextFormattingRules),
43+[TikiWiki
44+markup](https://doc.tiki.org/Wiki-Syntax-Text#The_Markup_Language_Wiki-Syntax),
45+[Creole 1.0](http://www.wikicreole.org/wiki/Creole1.0), [Haddock
46+markup](https://www.haskell.org/haddock/doc/html/ch03s08.html),
47+[OPML](http://dev.opml.org/spec2.html), [Emacs Org
48+mode](http://orgmode.org), [DocBook](http://docbook.org),
49+[JATS](https://jats.nlm.nih.gov),
50+[Muse](https://amusewiki.org/library/manual),
51+[txt2tags](http://txt2tags.org), [Vimwiki](https://vimwiki.github.io),
52+[EPUB](http://idpf.org/epub),
53+[ODT](http://en.wikipedia.org/wiki/OpenDocument), and [Word
54+docx](https://en.wikipedia.org/wiki/Office_Open_XML).
55+
56+Pandoc can write plain text,
57+[Markdown](http://daringfireball.net/projects/markdown/),
58+[CommonMark](http://commonmark.org), [PHP Markdown
59+Extra](https://michelf.ca/projects/php-markdown/extra/),
60+[GitHub-Flavored
61+Markdown](https://help.github.com/articles/github-flavored-markdown/),
62+[MultiMarkdown](http://fletcherpenney.net/multimarkdown/),
63+[reStructuredText](http://docutils.sourceforge.net/docs/ref/rst/introduction.html),
64+[XHTML](http://www.w3.org/TR/xhtml1/),
65+[HTML5](http://www.w3.org/TR/html5/), [LaTeX](http://latex-project.org)
66+(including [`beamer`](https://ctan.org/pkg/beamer) slide shows),
67+[ConTeXt](http://www.contextgarden.net/),
68+[RTF](http://en.wikipedia.org/wiki/Rich_Text_Format),
69+[OPML](http://dev.opml.org/spec2.html), [DocBook](http://docbook.org),
70+[JATS](https://jats.nlm.nih.gov),
71+[OpenDocument](http://opendocument.xml.org),
72+[ODT](http://en.wikipedia.org/wiki/OpenDocument), [Word
73+docx](https://en.wikipedia.org/wiki/Office_Open_XML), [GNU
74+Texinfo](http://www.gnu.org/software/texinfo/), [MediaWiki
75+markup](https://www.mediawiki.org/wiki/Help:Formatting), [DokuWiki
76+markup](https://www.dokuwiki.org/dokuwiki), [ZimWiki
77+markup](http://zim-wiki.org/manual/Help/Wiki_Syntax.html), [Haddock
78+markup](https://www.haskell.org/haddock/doc/html/ch03s08.html),
79+[EPUB](http://idpf.org/epub) (v2 or v3),
80+[FictionBook2](http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1),
81+[Textile](http://redcloth.org/textile), [groff
82+man](http://man7.org/linux/man-pages/man7/groff_man.7.html), [groff
83+ms](http://man7.org/linux/man-pages/man7/groff_ms.7.html), [Emacs Org
84+mode](http://orgmode.org),
85+[AsciiDoc](http://www.methods.co.nz/asciidoc/), [InDesign
86+ICML](https://www.adobe.com/content/dam/Adobe/en/devnet/indesign/cs55-docs/IDML/idml-specification.pdf),
87+[TEI Simple](https://github.com/TEIC/TEI-Simple),
88+[Muse](https://amusewiki.org/library/manual),
89+[PowerPoint](https://en.wikipedia.org/wiki/Microsoft_PowerPoint) slide
90+shows and [Slidy](http://www.w3.org/Talks/Tools/Slidy/),
91+[Slideous](http://goessner.net/articles/slideous/),
92+[DZSlides](http://paulrouget.com/dzslides/),
93+[reveal.js](http://lab.hakim.se/reveal-js/) or
94+[S5](http://meyerweb.com/eric/tools/s5/) HTML slide shows. It can also
95+produce [PDF](https://www.adobe.com/pdf/) output on systems where LaTeX,
96+ConTeXt, `pdfroff`, `wkhtmltopdf`, `prince`, or `weasyprint` is
97+installed.
98+
99+Pandoc’s enhanced version of Markdown includes syntax for tables,
56100definition lists, metadata blocks, `Div` blocks, footnotes and
57101citations, embedded LaTeX (including math), Markdown inside HTML block
58102elements, and much more. These enhancements, described further under
59−Pandoc's Markdown, can be disabled using the `markdown_strict` format.
103+Pandoc’s Markdown, can be disabled using the `markdown_strict` format.
60104
61105Pandoc has a modular design: it consists of a set of readers, which
62106parse text in a given format and produce a native representation of the
63107document (like an *abstract syntax tree* or AST), and a set of writers,
64108which convert this native representation into a target format. Thus,
65109adding an input or output format requires only adding a reader or
66−writer. Users can also run custom [pandoc filters] to modify the
67−intermediate AST.
110+writer. Users can also run custom [pandoc
111+filters](http://pandoc.org/filters.html) to modify the intermediate AST.
68112
69−Because pandoc's intermediate representation of a document is less
113+Because pandoc’s intermediate representation of a document is less
70114expressive than many of the formats it converts between, one should not
71115expect perfect conversions between every format and every other. Pandoc
72116attempts to preserve the structural elements of a document, but not
73117formatting details such as margin size. And some document elements, such
74−as complex tables, may not fit into pandoc's simple document model.
75−While conversions from pandoc's Markdown to all formats aspire to be
76−perfect, conversions from formats more expressive than pandoc's Markdown
118+as complex tables, may not fit into pandoc’s simple document model.
119+While conversions from pandoc’s Markdown to all formats aspire to be
120+perfect, conversions from formats more expressive than pandoc’s Markdown
77121can be expected to be lossy.
78122
79−Using `pandoc`
80−--------------
81−:::
82−
83− [Haskell]: https://www.haskell.org
84− [Markdown]: http://daringfireball.net/projects/markdown/
85− [CommonMark]: http://commonmark.org
86− [PHP Markdown Extra]: https://michelf.ca/projects/php-markdown/extra/
87− [GitHub-Flavored Markdown]: https://help.github.com/articles/github-flavored-markdown/
88− [MultiMarkdown]: http://fletcherpenney.net/multimarkdown/
89− [Textile]: http://redcloth.org/textile
90− [reStructuredText]: http://docutils.sourceforge.net/docs/ref/rst/introduction.html
91− [HTML]: http://www.w3.org/html/
92− [LaTeX]: http://latex-project.org
93− [MediaWiki markup]: https://www.mediawiki.org/wiki/Help:Formatting
94− [TWiki markup]: http://twiki.org/cgi-bin/view/TWiki/TextFormattingRules
95− [TikiWiki markup]: https://doc.tiki.org/Wiki-Syntax-Text#The_Markup_Language_Wiki-Syntax
96− [Creole 1.0]: http://www.wikicreole.org/wiki/Creole1.0
97− [Haddock markup]: https://www.haskell.org/haddock/doc/html/ch03s08.html
98− [OPML]: http://dev.opml.org/spec2.html
99− [Emacs Org mode]: http://orgmode.org
100− [DocBook]: http://docbook.org
101− [JATS]: https://jats.nlm.nih.gov
102− [Muse]: https://amusewiki.org/library/manual
103− [txt2tags]: http://txt2tags.org
104− [Vimwiki]: https://vimwiki.github.io
105− [EPUB]: http://idpf.org/epub
106− [ODT]: http://en.wikipedia.org/wiki/OpenDocument
107− [Word docx]: https://en.wikipedia.org/wiki/Office_Open_XML
108− [XHTML]: http://www.w3.org/TR/xhtml1/
109− [HTML5]: http://www.w3.org/TR/html5/
110− [`beamer`]: https://ctan.org/pkg/beamer
111− [ConTeXt]: http://www.contextgarden.net/
112− [RTF]: http://en.wikipedia.org/wiki/Rich_Text_Format
113− [OpenDocument]: http://opendocument.xml.org
114− [GNU Texinfo]: http://www.gnu.org/software/texinfo/
115− [DokuWiki markup]: https://www.dokuwiki.org/dokuwiki
116− [ZimWiki markup]: http://zim-wiki.org/manual/Help/Wiki_Syntax.html
117− [FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1
118− [groff man]: http://man7.org/linux/man-pages/man7/groff_man.7.html
119− [groff ms]: http://man7.org/linux/man-pages/man7/groff_ms.7.html
120− [AsciiDoc]: http://www.methods.co.nz/asciidoc/
121− [InDesign ICML]: https://www.adobe.com/content/dam/Adobe/en/devnet/indesign/cs55-docs/IDML/idml-specification.pdf
122− [TEI Simple]: https://github.com/TEIC/TEI-Simple
123− [PowerPoint]: https://en.wikipedia.org/wiki/Microsoft_PowerPoint
124− [Slidy]: http://www.w3.org/Talks/Tools/Slidy/
125− [Slideous]: http://goessner.net/articles/slideous/
126− [DZSlides]: http://paulrouget.com/dzslides/
127− [reveal.js]: http://lab.hakim.se/reveal-js/
128− [S5]: http://meyerweb.com/eric/tools/s5/
129− [PDF]: https://www.adobe.com/pdf/
130− [pandoc filters]: http://pandoc.org/filters.html
131−
132−Installing
133−----------
134−
135−Here's [how to install pandoc].
136−
137− [how to install pandoc]: INSTALL.md
138−
139−Documentation
140−-------------
141−
142−Pandoc's website contains a full [User's Guide]. It is also available
143−[here] as pandoc-flavored Markdown. The website also contains some
144−[examples of the use of pandoc] and a limited [online demo].
145−
146− [User's Guide]: https://pandoc.org/MANUAL.html
147− [here]: MANUAL.txt
148− [examples of the use of pandoc]: https://pandoc.org/demos.html
149− [online demo]: https://pandoc.org/try
150−
151−Contributing
152−------------
123+## Using `pandoc`
153124
154−Pull requests, bug reports, and feature requests are welcome. Please
155−make sure to read [the contributor guidelines] before opening a new
156−issue.
125+</div>
157126
158− [the contributor guidelines]: CONTRIBUTING.md
127+## Installing
159128
160−License
161−-------
129+Here’s [how to install pandoc](INSTALL.md).
162130
163−© 2006-2017 John MacFarlane (jgm@berkeley.edu). Released under the
164−[GPL], version 2 or greater. This software carries no warranty of any
165−kind. (See COPYRIGHT for full copyright and warranty notices.)
131+## Documentation
132+
133+Pandoc’s website contains a full [User’s
134+Guide](https://pandoc.org/MANUAL.html). It is also available
135+[here](MANUAL.txt) as pandoc-flavored Markdown. The website also
136+contains some [examples of the use of
137+pandoc](https://pandoc.org/demos.html) and a limited [online
138+demo](https://pandoc.org/try).
139+
140+## Contributing
166141
167− [GPL]: http://www.gnu.org/copyleft/gpl.html
168− "GNU General Public License"
142+Pull requests, bug reports, and feature requests are welcome. Please
143+make sure to read [the contributor guidelines](CONTRIBUTING.md) before
144+opening a new issue.
145+
146+## License
147+
148+© 2006-2017 John MacFarlane (jgm@berkeley.edu). Released under the
149+[GPL](http://www.gnu.org/copyleft/gpl.html "GNU General Public License"),
150+version 2 or greater. This software carries no warranty of any kind.
151+(See COPYRIGHT for full copyright and warranty notices.)