"Fossies" - the Fresh Open Source Software Archive

Member "pandoc-2.18/README.template" (4 Apr 2022, 3756 Bytes) of package /linux/www/pandoc-2.18.tar.gz:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. See also the last Fossies "Diffs" side-by-side code changes report for "README.template": 2.16.2_vs_2.17.

    1 <!-- Do not edit this file.  It is generated automatically from
    2 README.template and MANUAL.txt via the command:
    3 pandoc --lua-filter tools/update-readme.lua README.template -o README.md
    4 -->
    5 
    6 Pandoc
    7 ======
    8 
    9 [![github release](https://img.shields.io/github/release/jgm/pandoc.svg?label=current+release)](https://github.com/jgm/pandoc/releases)
   10 [![hackage release](https://img.shields.io/hackage/v/pandoc.svg?label=hackage)](https://hackage.haskell.org/package/pandoc)
   11 [![homebrew](https://img.shields.io/homebrew/v/pandoc.svg)](https://formulae.brew.sh/formula/pandoc)
   12 [![stackage LTS package](https://stackage.org/package/pandoc/badge/lts)](https://www.stackage.org/lts/package/pandoc-types)
   13 [![CI tests](https://github.com/jgm/pandoc/workflows/CI%20tests/badge.svg)](https://github.com/jgm/pandoc/actions)
   14 [![license](https://img.shields.io/badge/license-GPLv2+-lightgray.svg)](https://www.gnu.org/licenses/gpl.html)
   15 [![pandoc-discuss on google groups](https://img.shields.io/badge/pandoc-discuss-red.svg?style=social)](https://groups.google.com/forum/#!forum/pandoc-discuss)
   16 
   17 
   18 The universal markup converter
   19 ------------------------------
   20 
   21 Pandoc is a [Haskell] library for converting from one markup format to
   22 another, and a command-line tool that uses this library.  It can convert *from*
   23 
   24 ::: {#input-formats}
   25 :::
   26 
   27 It can convert *to*
   28 
   29 ::: {#output-formats}
   30 :::
   31 
   32 Pandoc can also produce PDF output via LaTeX, Groff ms, or HTML.
   33 
   34 Pandoc's enhanced version of Markdown includes syntax for tables,
   35 definition lists, metadata blocks, footnotes, citations, math,
   36 and much more.  See the User's Manual below under
   37 [Pandoc's Markdown](https://pandoc.org/MANUAL.html#pandocs-markdown).
   38 
   39 Pandoc has a modular design: it consists of a set of readers, which parse
   40 text in a given format and produce a native representation of the document
   41 (an _abstract syntax tree_ or AST), and a set of writers, which convert
   42 this native representation into a target format. Thus, adding an input
   43 or output format requires only adding a reader or writer. Users can also
   44 run custom pandoc filters to modify the intermediate AST (see
   45 the documentation for [filters](https://pandoc.org/filters.html)
   46 and [Lua filters](https://pandoc.org/lua-filters.html)).
   47 
   48 Because pandoc's intermediate representation of a document is less
   49 expressive than many of the formats it converts between, one should
   50 not expect perfect conversions between every format and every other.
   51 Pandoc attempts to preserve the structural elements of a document, but
   52 not formatting details such as margin size.  And some document elements,
   53 such as complex tables, may not fit into pandoc's simple document
   54 model.  While conversions from pandoc's Markdown to all formats aspire
   55 to be perfect, conversions from formats more expressive than pandoc's
   56 Markdown can be expected to be lossy.
   57 
   58 
   59 Installing
   60 ----------
   61 
   62 Here's [how to install pandoc](INSTALL.md).
   63 
   64 Documentation
   65 -------------
   66 
   67 Pandoc's website contains a full [User's Guide](https://pandoc.org/MANUAL.html).
   68 It is also available [here](MANUAL.txt) as pandoc-flavored Markdown.
   69 The website also contains some [examples of the use of
   70 pandoc](https://pandoc.org/demos.html) and a limited [online
   71 demo](https://pandoc.org/try).
   72 
   73 Contributing
   74 ------------
   75 
   76 Pull requests, bug reports, and feature requests are welcome.  Please make
   77 sure to read [the contributor guidelines](CONTRIBUTING.md) before opening a
   78 new issue.
   79 
   80 
   81 License
   82 -------
   83 
   84 © 2006-2022 John MacFarlane (jgm@berkeley.edu). Released under the
   85 [GPL], version 2 or greater.  This software carries no warranty of
   86 any kind.  (See COPYRIGHT for full copyright and warranty notices.)
   87 
   88 [GPL]: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html "GNU General Public License"
   89 [Haskell]: https://haskell.org