-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/

-- | HTML formatter for skylighting syntax highlighting library
--   
--   This module allows tokens produced by skylighting-core to be rendered
--   as HTML.
@package skylighting-format-blaze-html
@version 0.1.1.3

module Skylighting.Format.HTML

-- | Format tokens using HTML spans inside code tags. For example,
--   A KeywordTok is rendered as a span with class kw.
--   Short class names correspond to TokenTypes as follows:
--   KeywordTok = kw, DataTypeTok = dt,
--   DecValTok = dv, BaseNTok = bn,
--   FloatTok = fl, CharTok = ch,
--   StringTok = st, CommentTok = co,
--   OtherTok = ot, AlertTok = al,
--   FunctionTok = fu, RegionMarkerTok =
--   re, ErrorTok = er, ConstantTok =
--   cn, SpecialCharTok = sc,
--   VerbatimStringTok = vs, SpecialStringTok =
--   ss, ImportTok = im, DocumentationTok =
--   do, AnnotationTok = an, CommentVarTok
--   = cv, VariableTok = va, ControlFlowTok
--   = cf, OperatorTok = op, BuiltInTok =
--   bu, ExtensionTok = ex, PreprocessorTok
--   = pp, AttributeTok = at,
--   InformationTok = in, WarningTok = wa.
--   A NormalTok is not marked up at all.
formatHtmlInline :: FormatOptions -> [SourceLine] -> Html

-- | Format tokens as an HTML pre block. Each line is wrapped in
--   an a element with the class ‘source-line’. If line numbering is
--   selected, the surrounding pre is given the class ‘numberSource’, and
--   the resulting html will display line numbers thanks to the included
--   CSS. See the documentation for formatHtmlInline for information
--   about how tokens are encoded.
formatHtmlBlock :: FormatOptions -> [SourceLine] -> Html

-- | Like formatHtmlBlock but uses only attributes valid in HTML 4
--   (so, aria-hidden is not used in empty line number spans).
formatHtml4Block :: FormatOptions -> [SourceLine] -> Html

-- | Returns CSS for styling highlighted code according to the given style.
styleToCss :: Style -> String
instance GHC.Classes.Eq Skylighting.Format.HTML.HtmlVersion
instance GHC.Internal.Show.Show Skylighting.Format.HTML.HtmlVersion
