| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
Language.Drasil.Markdown.CreateMd
Contents
Description
Markdown file creator for generated GOOL code.
Synopsis
- makeMd :: [Doc] -> Doc
- introInfo :: String -> [String] -> Maybe String -> Doc
- whatInfo :: Maybe String -> Doc
- verInfo :: String -> String -> Doc
- unsupOS :: Maybe String -> Doc
- extLibSec :: [(String, String)] -> [String] -> Doc
- regularSec :: Doc -> Doc -> Doc
- instDoc :: [String] -> String -> (String, String) -> Doc
- endNote :: Int -> [String] -> Doc
Main Function
makeMd :: [Doc] -> Doc Source #
Combines a list of sentences into a final Doc, also appends end note.
Section Creators
introInfo :: String -> [String] -> Maybe String -> Doc Source #
Example title, authors, and maybe purpose section.
whatInfo :: Maybe String -> Doc Source #
What section in generated README file, does not display if empty
unsupOS :: Maybe String -> Doc Source #
Invalid Operating Systems section, does not display unless atleast 1 invalid OS.
extLibSec :: [(String, String)] -> [String] -> Doc Source #
External Libraries section. The inputs are a list of name and version pairs and a list of the corresponding version numbers, these are first combined into a list of triplets, and then each printed on a new line.