aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJohn MacFarlane <jgm@berkeley.edu>2020-11-19 13:04:46 -0800
committerJohn MacFarlane <jgm@berkeley.edu>2020-11-19 13:05:02 -0800
commit0c8ab8a12f69cdb2868ffe223aa938044fd447b4 (patch)
treef73a4f52034b57ffc49cc18ea21c74903c6534c5 /README.md
parentb36ffef38efd3ec90b01d1f689aee60e6afd8feb (diff)
downloadpandoc-0c8ab8a12f69cdb2868ffe223aa938044fd447b4.tar.gz
Update README.md, man page.
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 6 insertions, 12 deletions
diff --git a/README.md b/README.md
index 1b1951e81..aea55b0c4 100644
--- a/README.md
+++ b/README.md
@@ -3,8 +3,7 @@ README.template and MANUAL.txt via the command:
pandoc --lua-filter tools/update-readme.lua README.template -o README.md
-->
-Pandoc
-======
+# Pandoc
[![github
release](https://img.shields.io/github/release/jgm/pandoc.svg?label=current+release)](https://github.com/jgm/pandoc/releases)
@@ -19,8 +18,7 @@ tests](https://github.com/jgm/pandoc/workflows/CI%20tests/badge.svg)](https://gi
[![pandoc-discuss on google
groups](https://img.shields.io/badge/pandoc-discuss-red.svg?style=social)](https://groups.google.com/forum/#!forum/pandoc-discuss)
-The universal markup converter
-------------------------------
+## The universal markup converter
Pandoc is a [Haskell](http://haskell.org) library for converting from
one markup format to another, and a command-line tool that uses this
@@ -217,13 +215,11 @@ 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
-----------
+## Installing
Here’s [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
@@ -232,15 +228,13 @@ contains some [examples of the use of
pandoc](https://pandoc.org/demos.html) and a limited [online
demo](https://pandoc.org/try).
-Contributing
-------------
+## Contributing
Pull requests, bug reports, and feature requests are welcome. Please
make sure to read [the contributor guidelines](CONTRIBUTING.md) before
opening a new issue.
-License
--------
+## License
© 2006-2020 John MacFarlane (jgm@berkeley.edu). Released under the
[GPL](http://www.gnu.org/copyleft/gpl.html "GNU General Public License"),