summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorickc <ickc@users.noreply.github.com>2016-10-22 13:33:45 -0700
committerJohn MacFarlane <jgm@berkeley.edu>2016-10-22 22:33:45 +0200
commit8b9cce97920d62a4b85a88eac8433512226329a9 (patch)
tree88383354e723880b14ae9f7680d5108609e6d33b
parent48519861877327743d6accbde9b65a095265b0b0 (diff)
"Merge" MANUAL.txt into README.md (#3167)
* "Merge" MANUAL.txt into README.md Pull request #3157 without the automatic building from MANUAL.txt to README.md * remove contributors in README.md
-rw-r--r--MANUAL.txt10
-rw-r--r--README.md41
2 files changed, 34 insertions, 17 deletions
diff --git a/MANUAL.txt b/MANUAL.txt
index 3c66ba658..6cabf1941 100644
--- a/MANUAL.txt
+++ b/MANUAL.txt
@@ -18,10 +18,10 @@ another, and a command-line tool that uses this library. It can read
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],
+[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,
+[EPUB] \(v2 or v3\), [FictionBook2], [Textile], [groff man] pages,
[Emacs Org mode], [AsciiDoc], [InDesign ICML], [TEI Simple], 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
@@ -31,8 +31,8 @@ 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][Extension: `markdown_in_html_blocks`]. (These enhancements, described below under
-[Pandoc's Markdown], can be disabled using the
+elements][Extension: `markdown_in_html_blocks`]. (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
@@ -3946,7 +3946,7 @@ which you can modify according to your needs, do
Authors
=======
-© 2006-2015 John MacFarlane (jgm@berkeley.edu). Released under the
+© 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.)
diff --git a/README.md b/README.md
index eaa8aa11a..41aecf219 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,14 @@
Pandoc
======
+[![license](https://img.shields.io/badge/license-GPLv2+-brightgreen.svg)](https://www.gnu.org/licenses/gpl.html)
+[![hackage release](https://img.shields.io/hackage/v/pandoc.svg?label=current+release)](http://hackage.haskell.org/package/pandoc)
+[![stackage LTS package](http://stackage.org/package/pandoc/badge/lts)](http://stackage.org/lts/package/pandoc)
+[![github release](https://img.shields.io/github/release/jgm/pandoc.svg?label=github+release)](https://github.com/jgm/pandoc/releases)
+[![travis build status](https://img.shields.io/travis/jgm/pandoc.svg)](https://travis-ci.org/jgm/pandoc)
+[![appveyor build status](https://ci.appveyor.com/api/projects/status/nvqs4ct090igjiqc?svg=true)](https://ci.appveyor.com/project/jgm/pandoc)
+
+
The universal markup converter
------------------------------
@@ -21,12 +29,13 @@ markup], [DokuWiki markup], [ZimWiki markup], [Haddock markup],
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 in the manual under *pandoc's Markdown*, can be
-disabled using the `markdown_strict` input or output format.)
+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
@@ -87,14 +96,22 @@ Markdown can be expected to be lossy.
[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
-[![license](https://img.shields.io/badge/license-GPLv2+-brightgreen.svg)](https://www.gnu.org/licenses/gpl.html)
-[![hackage release](https://img.shields.io/hackage/v/pandoc.svg?label=current+release)](http://hackage.haskell.org/package/pandoc)
-[![stackage LTS package](http://stackage.org/package/pandoc/badge/lts)](http://stackage.org/lts/package/pandoc)
-[![github release](https://img.shields.io/github/release/jgm/pandoc.svg?label=github+release)](https://github.com/jgm/pandoc/releases)
-[![travis build status](https://img.shields.io/travis/jgm/pandoc.svg)](https://travis-ci.org/jgm/pandoc)
-[![appveyor build status](https://ci.appveyor.com/api/projects/status/nvqs4ct090igjiqc?svg=true)](https://ci.appveyor.com/project/jgm/pandoc)
+
+[footnotes]: http://pandoc.org/MANUAL.html#footnotes
+[tables]: http://pandoc.org/MANUAL.html#tables
+[ordered lists]: http://pandoc.org/MANUAL.html#ordered-lists
+[definition lists]: http://pandoc.org/MANUAL.html#definition-lists
+[fenced code blocks]: http://pandoc.org/MANUAL.html#fenced-code-blocks
+[superscripts and subscripts]: http://pandoc.org/MANUAL.html#superscripts-and-subscripts
+[strikeout]: http://pandoc.org/MANUAL.html#strikeout
+[metadata blocks]: http://pandoc.org/MANUAL.html#metadata-blocks
+[math]: http://pandoc.org/MANUAL.html#math
+[citations]: http://pandoc.org/MANUAL.html#citations
+[Markdown inside HTML block elements]: http://pandoc.org/MANUAL.html#extension-markdown_in_html_blocks
+[Pandoc's Markdown]: http://pandoc.org/MANUAL.html#pandocs-markdown
+
Documentation
-------------