From fb2759d1c7c19d5790c0fe1b719ccc93539a6884 Mon Sep 17 00:00:00 2001 From: Herbert Valerio Riedel Date: Thu, 20 Jul 2017 12:08:53 +0200 Subject: Import @aisamanra's Haddock cheatsheet from https://github.com/aisamanra/haddock-cheatsheet --- doc/cheatsheet/README.md | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 doc/cheatsheet/README.md (limited to 'doc/cheatsheet/README.md') 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. -- cgit v1.2.3