Tissevert/pandoc
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

Use gfm for generated README.md.

Browse source
This commit is contained in:
John MacFarlane 2017-12-30 10:40:06 -08:00
parent 551aec7b01
commit 69e262fc5b
2 changed files with 114 additions and 131 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
Makefile
View file

@ -84,7 +84,7 @@ doc/lua-filters.md: tools/ldoc.ltp data/pandoc.lua tools/update-lua-docs.lua
README.md: README.template MANUAL.txt tools/update-readme.lua README.md: README.template MANUAL.txt tools/update-readme.lua
pandoc --lua-filter tools/update-readme.lua --reference-links \ pandoc --lua-filter tools/update-readme.lua --reference-links \
--reference-location=section $< -o $@ --reference-location=section -t gfm $< -o $@
download_stats: download_stats:
curl https://api.github.com/repos/jgm/pandoc/releases | \ curl https://api.github.com/repos/jgm/pandoc/releases | \

243
README.md
View file

@ -2,167 +2,150 @@
README.template and MANUAL.txt via the command: README.template and MANUAL.txt via the command:
pandoc --lua-filter tools/update-readme.lua README.template -o README.md pandoc --lua-filter tools/update-readme.lua README.template -o README.md
--> -->
Pandoc
======
[![github release][]][] [![hackage release][]][] [![homebrew][]][] # Pandoc
[![stackage LTS package][]][] [![travis build status][]][] [![appveyor
build status][]][] [![license][]][] [![pandoc-discuss on google groups]]
[github release]: https://img.shields.io/github/release/jgm/pandoc.svg?label=current+release [![github
[![github release][]]: https://github.com/jgm/pandoc/releases release](https://img.shields.io/github/release/jgm/pandoc.svg?label=current+release)](https://github.com/jgm/pandoc/releases)
[hackage release]: https://img.shields.io/hackage/v/pandoc.svg?label=hackage [![hackage
[![hackage release][]]: http://hackage.haskell.org/package/pandoc release](https://img.shields.io/hackage/v/pandoc.svg?label=hackage)](http://hackage.haskell.org/package/pandoc)
[homebrew]: https://img.shields.io/homebrew/v/pandoc.svg [![homebrew](https://img.shields.io/homebrew/v/pandoc.svg)](http://brewformulas.org/Pandoc)
[![homebrew][]]: http://brewformulas.org/Pandoc [![stackage LTS
[stackage LTS package]: http://stackage.org/package/pandoc/badge/lts package](http://stackage.org/package/pandoc/badge/lts)](http://stackage.org/lts/package/pandoc)
[![stackage LTS package][]]: http://stackage.org/lts/package/pandoc [![travis build
[travis build status]: https://img.shields.io/travis/jgm/pandoc/master.svg?label=travis+build status](https://img.shields.io/travis/jgm/pandoc/master.svg?label=travis+build)](https://travis-ci.org/jgm/pandoc)
[![travis build status][]]: https://travis-ci.org/jgm/pandoc [![appveyor build
[appveyor build status]: https://ci.appveyor.com/api/projects/status/nvqs4ct090igjiqc?svg=true status](https://ci.appveyor.com/api/projects/status/nvqs4ct090igjiqc?svg=true)](https://ci.appveyor.com/project/jgm/pandoc)
[![appveyor build status][]]: https://ci.appveyor.com/project/jgm/pandoc [![license](https://img.shields.io/badge/license-GPLv2+-lightgray.svg)](https://www.gnu.org/licenses/gpl.html)
[license]: https://img.shields.io/badge/license-GPLv2+-lightgray.svg [![pandoc-discuss on google
[![license][]]: https://www.gnu.org/licenses/gpl.html groups](https://img.shields.io/badge/pandoc-discuss-red.svg?style=social)](https://groups.google.com/forum/#!forum/pandoc-discuss)
[pandoc-discuss on google groups]: https://img.shields.io/badge/pandoc-discuss-red.svg?style=social
[![pandoc-discuss on google groups]]: https://groups.google.com/forum/#!forum/pandoc-discuss
The universal markup converter ## The universal markup converter
------------------------------
::: {#description} <div id="description">
Pandoc is a [Haskell] library for converting from one markup format to
another, and a command-line tool that uses this library.
Pandoc can read [Markdown], [CommonMark], [PHP Markdown Extra], Pandoc is a [Haskell](https://www.haskell.org) library for converting
[GitHub-Flavored Markdown], [MultiMarkdown], and (subsets of) [Textile], from one markup format to another, and a command-line tool that uses
[reStructuredText], [HTML], [LaTeX], [MediaWiki markup], [TWiki markup], this library.
[TikiWiki markup], [Creole 1.0], [Haddock markup], [OPML], [Emacs Org
mode], [DocBook], [JATS], [Muse], [txt2tags], [Vimwiki], [EPUB], [ODT],
and [Word docx].
Pandoc can write plain text, [Markdown], [CommonMark], [PHP Markdown Pandoc can read
Extra], [GitHub-Flavored Markdown], [MultiMarkdown], [reStructuredText], [Markdown](http://daringfireball.net/projects/markdown/),
[XHTML], [HTML5], [LaTeX] (including [`beamer`] slide shows), [ConTeXt], [CommonMark](http://commonmark.org), [PHP Markdown
[RTF], [OPML], [DocBook], [JATS], [OpenDocument], [ODT], [Word docx], Extra](https://michelf.ca/projects/php-markdown/extra/),
[GNU Texinfo], [MediaWiki markup], [DokuWiki markup], [ZimWiki markup], [GitHub-Flavored
[Haddock markup], [EPUB] (v2 or v3), [FictionBook2], [Textile], [groff Markdown](https://help.github.com/articles/github-flavored-markdown/),
man], [groff ms], [Emacs Org mode], [AsciiDoc], [InDesign ICML], [TEI [MultiMarkdown](http://fletcherpenney.net/multimarkdown/), and (subsets
Simple], [Muse], [PowerPoint] slide shows and [Slidy], [Slideous], of) [Textile](http://redcloth.org/textile),
[DZSlides], [reveal.js] or [S5] HTML slide shows. It can also produce [reStructuredText](http://docutils.sourceforge.net/docs/ref/rst/introduction.html),
[PDF] output on systems where LaTeX, ConTeXt, `pdfroff`, `wkhtmltopdf`, [HTML](http://www.w3.org/html/), [LaTeX](http://latex-project.org),
`prince`, or `weasyprint` is installed. [MediaWiki markup](https://www.mediawiki.org/wiki/Help:Formatting),
[TWiki markup](http://twiki.org/cgi-bin/view/TWiki/TextFormattingRules),
[TikiWiki
markup](https://doc.tiki.org/Wiki-Syntax-Text#The_Markup_Language_Wiki-Syntax),
[Creole 1.0](http://www.wikicreole.org/wiki/Creole1.0), [Haddock
markup](https://www.haskell.org/haddock/doc/html/ch03s08.html),
[OPML](http://dev.opml.org/spec2.html), [Emacs Org
mode](http://orgmode.org), [DocBook](http://docbook.org),
[JATS](https://jats.nlm.nih.gov),
[Muse](https://amusewiki.org/library/manual),
[txt2tags](http://txt2tags.org), [Vimwiki](https://vimwiki.github.io),
[EPUB](http://idpf.org/epub),
[ODT](http://en.wikipedia.org/wiki/OpenDocument), and [Word
docx](https://en.wikipedia.org/wiki/Office_Open_XML).
Pandoc's enhanced version of Markdown includes syntax for tables, Pandoc can write plain text,
[Markdown](http://daringfireball.net/projects/markdown/),
[CommonMark](http://commonmark.org), [PHP Markdown
Extra](https://michelf.ca/projects/php-markdown/extra/),
[GitHub-Flavored
Markdown](https://help.github.com/articles/github-flavored-markdown/),
[MultiMarkdown](http://fletcherpenney.net/multimarkdown/),
[reStructuredText](http://docutils.sourceforge.net/docs/ref/rst/introduction.html),
[XHTML](http://www.w3.org/TR/xhtml1/),
[HTML5](http://www.w3.org/TR/html5/), [LaTeX](http://latex-project.org)
(including [`beamer`](https://ctan.org/pkg/beamer) slide shows),
[ConTeXt](http://www.contextgarden.net/),
[RTF](http://en.wikipedia.org/wiki/Rich_Text_Format),
[OPML](http://dev.opml.org/spec2.html), [DocBook](http://docbook.org),
[JATS](https://jats.nlm.nih.gov),
[OpenDocument](http://opendocument.xml.org),
[ODT](http://en.wikipedia.org/wiki/OpenDocument), [Word
docx](https://en.wikipedia.org/wiki/Office_Open_XML), [GNU
Texinfo](http://www.gnu.org/software/texinfo/), [MediaWiki
markup](https://www.mediawiki.org/wiki/Help:Formatting), [DokuWiki
markup](https://www.dokuwiki.org/dokuwiki), [ZimWiki
markup](http://zim-wiki.org/manual/Help/Wiki_Syntax.html), [Haddock
markup](https://www.haskell.org/haddock/doc/html/ch03s08.html),
[EPUB](http://idpf.org/epub) (v2 or v3),
[FictionBook2](http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1),
[Textile](http://redcloth.org/textile), [groff
man](http://man7.org/linux/man-pages/man7/groff_man.7.html), [groff
ms](http://man7.org/linux/man-pages/man7/groff_ms.7.html), [Emacs Org
mode](http://orgmode.org),
[AsciiDoc](http://www.methods.co.nz/asciidoc/), [InDesign
ICML](https://www.adobe.com/content/dam/Adobe/en/devnet/indesign/cs55-docs/IDML/idml-specification.pdf),
[TEI Simple](https://github.com/TEIC/TEI-Simple),
[Muse](https://amusewiki.org/library/manual),
[PowerPoint](https://en.wikipedia.org/wiki/Microsoft_PowerPoint) slide
shows and [Slidy](http://www.w3.org/Talks/Tools/Slidy/),
[Slideous](http://goessner.net/articles/slideous/),
[DZSlides](http://paulrouget.com/dzslides/),
[reveal.js](http://lab.hakim.se/reveal-js/) or
[S5](http://meyerweb.com/eric/tools/s5/) HTML slide shows. It can also
produce [PDF](https://www.adobe.com/pdf/) output on systems where LaTeX,
ConTeXt, `pdfroff`, `wkhtmltopdf`, `prince`, or `weasyprint` is
installed.
Pandoc’s enhanced version of Markdown includes syntax for tables,
definition lists, metadata blocks, `Div` blocks, footnotes and definition lists, metadata blocks, `Div` blocks, footnotes and
citations, embedded LaTeX (including math), Markdown inside HTML block citations, embedded LaTeX (including math), Markdown inside HTML block
elements, and much more. These enhancements, described further under elements, and much more. These enhancements, described further under
Pandoc's Markdown, can be disabled using the `markdown_strict` format. Pandoc’s Markdown, can be disabled using the `markdown_strict` format.
Pandoc has a modular design: it consists of a set of readers, which 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 parse text in a given format and produce a native representation of the
document (like an *abstract syntax tree* or AST), and a set of writers, document (like an *abstract syntax tree* or AST), and a set of writers,
which convert this native representation into a target format. Thus, which convert this native representation into a target format. Thus,
adding an input or output format requires only adding a reader or adding an input or output format requires only adding a reader or
writer. Users can also run custom [pandoc filters] to modify the writer. Users can also run custom [pandoc
intermediate AST. filters](http://pandoc.org/filters.html) to modify the intermediate AST.
Because pandoc's intermediate representation of a document is less Because pandoc’s intermediate representation of a document is less
expressive than many of the formats it converts between, one should not expressive than many of the formats it converts between, one should not
expect perfect conversions between every format and every other. Pandoc expect perfect conversions between every format and every other. Pandoc
attempts to preserve the structural elements of a document, but not attempts to preserve the structural elements of a document, but not
formatting details such as margin size. And some document elements, such formatting details such as margin size. And some document elements, such
as complex tables, may not fit into pandoc's simple document model. as complex tables, may not fit into pandoc’s simple document model.
While conversions from pandoc's Markdown to all formats aspire to be While conversions from pandoc’s Markdown to all formats aspire to be
perfect, conversions from formats more expressive than pandoc's Markdown perfect, conversions from formats more expressive than pandoc’s Markdown
can be expected to be lossy. can be expected to be lossy.
Using `pandoc` ## Using `pandoc`
--------------
:::
[Haskell]: https://www.haskell.org </div>
[Markdown]: http://daringfireball.net/projects/markdown/
[CommonMark]: http://commonmark.org
[PHP Markdown Extra]: https://michelf.ca/projects/php-markdown/extra/
[GitHub-Flavored Markdown]: https://help.github.com/articles/github-flavored-markdown/
[MultiMarkdown]: http://fletcherpenney.net/multimarkdown/
[Textile]: http://redcloth.org/textile
[reStructuredText]: http://docutils.sourceforge.net/docs/ref/rst/introduction.html
[HTML]: http://www.w3.org/html/
[LaTeX]: http://latex-project.org
[MediaWiki markup]: https://www.mediawiki.org/wiki/Help:Formatting
[TWiki markup]: http://twiki.org/cgi-bin/view/TWiki/TextFormattingRules
[TikiWiki markup]: https://doc.tiki.org/Wiki-Syntax-Text#The_Markup_Language_Wiki-Syntax
[Creole 1.0]: http://www.wikicreole.org/wiki/Creole1.0
[Haddock markup]: https://www.haskell.org/haddock/doc/html/ch03s08.html
[OPML]: http://dev.opml.org/spec2.html
[Emacs Org mode]: http://orgmode.org
[DocBook]: http://docbook.org
[JATS]: https://jats.nlm.nih.gov
[Muse]: https://amusewiki.org/library/manual
[txt2tags]: http://txt2tags.org
[Vimwiki]: https://vimwiki.github.io
[EPUB]: http://idpf.org/epub
[ODT]: http://en.wikipedia.org/wiki/OpenDocument
[Word docx]: https://en.wikipedia.org/wiki/Office_Open_XML
[XHTML]: http://www.w3.org/TR/xhtml1/
[HTML5]: http://www.w3.org/TR/html5/
[`beamer`]: https://ctan.org/pkg/beamer
[ConTeXt]: http://www.contextgarden.net/
[RTF]: http://en.wikipedia.org/wiki/Rich_Text_Format
[OpenDocument]: http://opendocument.xml.org
[GNU Texinfo]: http://www.gnu.org/software/texinfo/
[DokuWiki markup]: https://www.dokuwiki.org/dokuwiki
[ZimWiki markup]: http://zim-wiki.org/manual/Help/Wiki_Syntax.html
[FictionBook2]: http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1
[groff man]: http://man7.org/linux/man-pages/man7/groff_man.7.html
[groff ms]: http://man7.org/linux/man-pages/man7/groff_ms.7.html
[AsciiDoc]: http://www.methods.co.nz/asciidoc/
[InDesign ICML]: https://www.adobe.com/content/dam/Adobe/en/devnet/indesign/cs55-docs/IDML/idml-specification.pdf
[TEI Simple]: https://github.com/TEIC/TEI-Simple
[PowerPoint]: https://en.wikipedia.org/wiki/Microsoft_PowerPoint
[Slidy]: http://www.w3.org/Talks/Tools/Slidy/
[Slideous]: http://goessner.net/articles/slideous/
[DZSlides]: http://paulrouget.com/dzslides/
[reveal.js]: http://lab.hakim.se/reveal-js/
[S5]: http://meyerweb.com/eric/tools/s5/
[PDF]: https://www.adobe.com/pdf/
[pandoc filters]: http://pandoc.org/filters.html
Installing ## Installing
----------
Here's [how to install pandoc]. Here’s [how to install pandoc](INSTALL.md).
[how to install pandoc]: INSTALL.md ## Documentation
Documentation Pandoc’s website contains a full [User’s
------------- Guide](https://pandoc.org/MANUAL.html). It is also available
[here](MANUAL.txt) as pandoc-flavored Markdown. The website also
contains some [examples of the use of
pandoc](https://pandoc.org/demos.html) and a limited [online
demo](https://pandoc.org/try).
Pandoc's website contains a full [User's Guide]. It is also available ## Contributing
[here] as pandoc-flavored Markdown. The website also contains some
[examples of the use of pandoc] and a limited [online demo].
[User's Guide]: https://pandoc.org/MANUAL.html
[here]: MANUAL.txt
[examples of the use of pandoc]: https://pandoc.org/demos.html
[online demo]: https://pandoc.org/try
Contributing
------------
Pull requests, bug reports, and feature requests are welcome. Please Pull requests, bug reports, and feature requests are welcome. Please
make sure to read [the contributor guidelines] before opening a new make sure to read [the contributor guidelines](CONTRIBUTING.md) before
issue. opening a new issue.
[the contributor guidelines]: CONTRIBUTING.md ## License
License
-------
© 2006-2017 John MacFarlane (jgm@berkeley.edu). Released under the © 2006-2017 John MacFarlane (jgm@berkeley.edu). Released under the
[GPL], version 2 or greater. This software carries no warranty of any [GPL](http://www.gnu.org/copyleft/gpl.html "GNU General Public License"),
kind. (See COPYRIGHT for full copyright and warranty notices.) version 2 or greater. This software carries no warranty of any kind.
(See COPYRIGHT for full copyright and warranty notices.)
[GPL]: http://www.gnu.org/copyleft/gpl.html
"GNU General Public License"