Safe Haskell	Safe
Language	Haskell2010

Language.Drasil.Markdown.CreateMd

Contents

Main Function
Section Creators

Description

Markdown file creator for generated GOOL code.

Synopsis

makeMd :: [Doc] -> Doc
introInfo :: String -> [String] -> Doc
verInfo :: String -> String -> Doc
unsupOS :: Maybe String -> Doc
extLibSec :: [(String, String)] -> [String] -> Doc
regularSec :: Doc -> Doc -> Doc
instDoc :: [String] -> Doc
endNote :: [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] -> Doc Source #

Example title and purpose section.

verInfo :: String -> String -> Doc Source #

Language version section.

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.

regularSec :: Doc -> Doc -> Doc Source #

Constructs regular section section from header and message.

instDoc :: [String] -> Doc Source #

Instruction section, contains 3 paragraphs, Running, Building and Config Files. The Config file section is only displayed if there are configuration files.

endNote :: [String] -> Doc Source #

End section.