From 72bdac3036cdab7c7fa3b02b5c7ac8ee93350cef Mon Sep 17 00:00:00 2001 From: John MacFarlane Date: Sun, 22 Apr 2018 11:36:47 -0700 Subject: New README template, take in/out formats from manual. --- README.template | 35 ++++++++++++++++++++++++++++++++++- 1 file changed, 34 insertions(+), 1 deletion(-) (limited to 'README.template') diff --git a/README.template b/README.template index cf664647a..cf4277441 100644 --- a/README.template +++ b/README.template @@ -19,9 +19,42 @@ Pandoc The universal markup converter ------------------------------ -::: description +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* + +::: {#input-formats} ::: +It can convert *to* + +::: {#output-formats} +::: + +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](https://pandoc.org/MANUAL.html#pandocs-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. + +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 ---------- -- cgit v1.2.3