aboutsummaryrefslogtreecommitdiff
path: root/doc/cheatsheet/README.md
diff options
context:
space:
mode:
authorHerbert Valerio Riedel <hvr@gnu.org>2017-07-20 12:08:53 +0200
committerHerbert Valerio Riedel <hvr@gnu.org>2017-07-20 12:08:53 +0200
commitfb2759d1c7c19d5790c0fe1b719ccc93539a6884 (patch)
treec03cb3d0ce2436a520b0de9a1377755189191716 /doc/cheatsheet/README.md
parent4f3fe0df65caea76ed268f1907918c19c7da4335 (diff)
Import @aisamanra's Haddock cheatsheet
from https://github.com/aisamanra/haddock-cheatsheet
Diffstat (limited to 'doc/cheatsheet/README.md')
-rw-r--r--doc/cheatsheet/README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/cheatsheet/README.md b/doc/cheatsheet/README.md
new file mode 100644
index 00000000..c5856217
--- /dev/null
+++ b/doc/cheatsheet/README.md
@@ -0,0 +1,9 @@
+![License: CC BY-SA 4.0](https://img.shields.io/badge/License-CC%20BY--SA%204.0-lightgrey.svg)
+
+# Haddock Markup Quick Reference
+
+This page is a single-page quick reference for the markup used in GHC's [Haddock](https://www.haskell.org/haddock/) documentation format. It doesn't list all the details of the format, just the basic markup, so for the vagaries and edge-cases of the syntax, it would be helpful to consult the [Haddock user guide](http://haskell-haddock.readthedocs.io/en/latest/index.html).
+
+## License
+
+This document is licensed under the CC BY-SA 4.0 license.