Text.BlogLiterately.Highlight

Syntax highlighting.

Documentation

data HsHighlight

Four modes for highlighting Haskell.

Constructors

HsColourInline StylePrefs

Use hscolour and inline the styles.

HsColourCSS

Use hscolour in conjunction with an external CSS style sheet.

HsKate

Use highlighting-kate.

HsNoHighlight

Do not highlight Haskell.

Instances

Eq HsHighlight

Defined in Text.BlogLiterately.Highlight

Methods

(==) :: HsHighlight -> HsHighlight -> Bool

(/=) :: HsHighlight -> HsHighlight -> Bool

Data HsHighlight

Defined in Text.BlogLiterately.Highlight

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> HsHighlight -> c HsHighlight

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c HsHighlight

toConstr :: HsHighlight -> Constr

dataTypeOf :: HsHighlight -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c HsHighlight)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c HsHighlight)

gmapT :: (forall b. Data b => b -> b) -> HsHighlight -> HsHighlight

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> HsHighlight -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> HsHighlight -> r

gmapQ :: (forall d. Data d => d -> u) -> HsHighlight -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> HsHighlight -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> HsHighlight -> m HsHighlight

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> HsHighlight -> m HsHighlight

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> HsHighlight -> m HsHighlight

Show HsHighlight

Defined in Text.BlogLiterately.Highlight

Methods

showsPrec :: Int -> HsHighlight -> ShowS

show :: HsHighlight -> String

showList :: [HsHighlight] -> ShowS

_HsColourInline :: Prism' HsHighlight StylePrefs

colourIt :: Bool -> Text -> String

Use hscolour to syntax highlight some Haskell code. The first argument indicates whether the code is literate Haskell.

litify :: Text -> Text

Prepend literate Haskell markers to some source code.

type StylePrefs = [(String, String)]

Style preferences are specified as a list of mappings from class attributes to CSS style attributes.

defaultStylePrefs :: StylePrefs

A default style that produces something that looks like the source listings on Hackage.

getStylePrefs :: Maybe FilePath -> IO StylePrefs

Read style preferences in from a file using the Read instance for StylePrefs, or return the default style if the file name is empty.

bakeStyles :: StylePrefs -> String -> String

Take a String of HTML produced by hscolour, and "bake" styles into it by replacing class attributes with appropriate style attributes.

replaceBreaks :: String -> String

Replace <br/> tags with newlines.

colouriseCodeBlock :: HsHighlight -> Bool -> Block -> Block

Transform a CodeBlock into a RawHtml block, where the content contains marked up Haskell (possibly with literate markers), or marked up non-Haskell, if highlighting of non-Haskell has been selected.

colourisePandoc :: HsHighlight -> Bool -> Pandoc -> Pandoc

Perform syntax highlighting on an entire Pandoc document.