drasil-printers-0.1.10.0: A framework for code and document generation for scientific software - Printers SubPackage
Safe HaskellSafe-Inferred
LanguageHaskell2010

Language.Drasil.Markdown.Helpers

Description

Defines helper functions for creating Markdown files.

Synopsis

Documentation

ang :: Doc -> Doc Source #

Angled brackets

bold :: Doc -> Doc Source #

Bold text

em :: Doc -> Doc Source #

Italicized text

li :: Doc -> Doc Source #

List tag wrapper

ul :: Doc -> Doc Source #

Unordered list tag wrapper.

divTag :: Doc -> Doc Source #

Helper for setting up section div

centeredDiv :: Doc -> Doc Source #

Helper for setting up centered div tags

centeredDivId :: Doc -> Doc -> Doc Source #

Helper for setting up centered div tags with an Id

reflink :: RefMap -> String -> Doc -> Doc Source #

Helper for setting up links to references

reflinkInfo :: RefMap -> String -> Doc -> Doc -> Doc Source #

Helper for setting up links to references with additional information.

reflinkURI :: Doc -> Doc -> Doc Source #

Helper for setting up links to external URIs

image :: Doc -> Maybe Doc -> Doc Source #

Helper for setting up figures

caption :: Doc -> Doc Source #

Helper for setting up captions

heading :: Doc -> Doc -> Doc Source #

Helper for setting up headings with an id attribute. id attribute will only work for mdBook.

h :: Int -> Doc Source #

Helper for setting up heading weights in mdBook.

h' :: Int -> Doc Source #

Helper for setting up heading weights in normal Markdown.

docLength :: Doc -> Int Source #

Helper for getting length of a Doc