Skip to content

MorrowM/haddock-md

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

haddock-md: A GHC plugin to use markdown in haddock documentation, powered by pandoc

Usage

  1. Install pandoc. Make sure it's on your PATH.
  2. Add this package as a dependency.
  3. Add the following to the top of your module:
{-# OPTIONS_GHC -fplugin=HaddockMd #-}

You can also enable it for the entire package (using cabal as an example):

ghc-options: -fplugin=HaddockMd

You can also choose a different format that pandoc supports reading:

-fplugin=HaddockMd:rst

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published