Safe Haskell | Safe-Inferred |
---|---|
Language | Haskell2010 |
Cheapskate.Types
Synopsis
- data Doc = Doc Options Blocks
- data Block
- data CodeAttr = CodeAttr {}
- data ListType
- data NumWrapper
- data HtmlTagType
- type Blocks = Seq Block
- data Inline
- type Inlines = Seq Inline
- type ReferenceMap = Map Text (Text, Text)
- data Options = Options {
- sanitize :: Bool
- allowRawHtml :: Bool
- preserveHardBreaks :: Bool
- debug :: Bool
Documentation
Structured representation of a document. The Options
affect
how the document is rendered by toHtml
.
Instances
ToMarkup Doc # | |||||
Defined in Cheapskate | |||||
NFData Doc # | |||||
Defined in Cheapskate.Types | |||||
Data Doc # | |||||
Defined in Cheapskate.Types Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Doc -> c Doc # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Doc # dataTypeOf :: Doc -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Doc) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Doc) # gmapT :: (forall b. Data b => b -> b) -> Doc -> Doc # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Doc -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Doc -> r # gmapQ :: (forall d. Data d => d -> u) -> Doc -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Doc -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Doc -> m Doc # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Doc -> m Doc # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Doc -> m Doc # | |||||
Generic Doc # | |||||
Defined in Cheapskate.Types Associated Types
| |||||
Show Doc # | |||||
type Rep Doc # | |||||
Defined in Cheapskate.Types type Rep Doc = D1 ('MetaData "Doc" "Cheapskate.Types" "cheapskate-0.1.1.2-3v4JTR45UgbGg2k0qjmKpG" 'False) (C1 ('MetaCons "Doc" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Options) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Blocks))) |
Block-level elements.
Constructors
Para Inlines | |
Header Int Inlines | |
Blockquote Blocks | |
List Bool ListType [Blocks] | |
CodeBlock CodeAttr Text | |
HtmlBlock Text | |
HRule |
Instances
Attributes for fenced code blocks. codeLang
is the
first word of the attribute line, codeInfo
is the rest.
Instances
NFData CodeAttr # | |||||
Defined in Cheapskate.Types | |||||
Data CodeAttr # | |||||
Defined in Cheapskate.Types Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CodeAttr -> c CodeAttr # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CodeAttr # toConstr :: CodeAttr -> Constr # dataTypeOf :: CodeAttr -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CodeAttr) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CodeAttr) # gmapT :: (forall b. Data b => b -> b) -> CodeAttr -> CodeAttr # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CodeAttr -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CodeAttr -> r # gmapQ :: (forall d. Data d => d -> u) -> CodeAttr -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> CodeAttr -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CodeAttr -> m CodeAttr # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CodeAttr -> m CodeAttr # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CodeAttr -> m CodeAttr # | |||||
Generic CodeAttr # | |||||
Defined in Cheapskate.Types Associated Types
| |||||
Show CodeAttr # | |||||
type Rep CodeAttr # | |||||
Defined in Cheapskate.Types type Rep CodeAttr = D1 ('MetaData "CodeAttr" "Cheapskate.Types" "cheapskate-0.1.1.2-3v4JTR45UgbGg2k0qjmKpG" 'False) (C1 ('MetaCons "CodeAttr" 'PrefixI 'True) (S1 ('MetaSel ('Just "codeLang") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "codeInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))) |
Constructors
Bullet Char | |
Numbered NumWrapper Int |
Instances
NFData ListType # | |||||
Defined in Cheapskate.Types | |||||
Data ListType # | |||||
Defined in Cheapskate.Types Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListType -> c ListType # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListType # toConstr :: ListType -> Constr # dataTypeOf :: ListType -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ListType) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListType) # gmapT :: (forall b. Data b => b -> b) -> ListType -> ListType # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListType -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListType -> r # gmapQ :: (forall d. Data d => d -> u) -> ListType -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ListType -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListType -> m ListType # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListType -> m ListType # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListType -> m ListType # | |||||
Generic ListType # | |||||
Defined in Cheapskate.Types Associated Types
| |||||
Show ListType # | |||||
Eq ListType # | |||||
type Rep ListType # | |||||
Defined in Cheapskate.Types type Rep ListType = D1 ('MetaData "ListType" "Cheapskate.Types" "cheapskate-0.1.1.2-3v4JTR45UgbGg2k0qjmKpG" 'False) (C1 ('MetaCons "Bullet" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Char)) :+: C1 ('MetaCons "Numbered" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 NumWrapper) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int))) |
data NumWrapper #
Constructors
PeriodFollowing | |
ParenFollowing |
Instances
NFData NumWrapper # | |||||
Defined in Cheapskate.Types Methods rnf :: NumWrapper -> () # | |||||
Data NumWrapper # | |||||
Defined in Cheapskate.Types Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> NumWrapper -> c NumWrapper # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c NumWrapper # toConstr :: NumWrapper -> Constr # dataTypeOf :: NumWrapper -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c NumWrapper) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c NumWrapper) # gmapT :: (forall b. Data b => b -> b) -> NumWrapper -> NumWrapper # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> NumWrapper -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> NumWrapper -> r # gmapQ :: (forall d. Data d => d -> u) -> NumWrapper -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> NumWrapper -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> NumWrapper -> m NumWrapper # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> NumWrapper -> m NumWrapper # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> NumWrapper -> m NumWrapper # | |||||
Generic NumWrapper # | |||||
Defined in Cheapskate.Types Associated Types
| |||||
Show NumWrapper # | |||||
Defined in Cheapskate.Types Methods showsPrec :: Int -> NumWrapper -> ShowS # show :: NumWrapper -> String # showList :: [NumWrapper] -> ShowS # | |||||
Eq NumWrapper # | |||||
Defined in Cheapskate.Types | |||||
type Rep NumWrapper # | |||||
data HtmlTagType #
Simple representation of HTML tag.
Instances
NFData HtmlTagType # | |||||
Defined in Cheapskate.Types Methods rnf :: HtmlTagType -> () # | |||||
Data HtmlTagType # | |||||
Defined in Cheapskate.Types Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> HtmlTagType -> c HtmlTagType # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c HtmlTagType # toConstr :: HtmlTagType -> Constr # dataTypeOf :: HtmlTagType -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c HtmlTagType) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c HtmlTagType) # gmapT :: (forall b. Data b => b -> b) -> HtmlTagType -> HtmlTagType # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> HtmlTagType -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> HtmlTagType -> r # gmapQ :: (forall d. Data d => d -> u) -> HtmlTagType -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> HtmlTagType -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> HtmlTagType -> m HtmlTagType # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> HtmlTagType -> m HtmlTagType # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> HtmlTagType -> m HtmlTagType # | |||||
Generic HtmlTagType # | |||||
Defined in Cheapskate.Types Associated Types
| |||||
Show HtmlTagType # | |||||
Defined in Cheapskate.Types Methods showsPrec :: Int -> HtmlTagType -> ShowS # show :: HtmlTagType -> String # showList :: [HtmlTagType] -> ShowS # | |||||
type Rep HtmlTagType # | |||||
Defined in Cheapskate.Types type Rep HtmlTagType = D1 ('MetaData "HtmlTagType" "Cheapskate.Types" "cheapskate-0.1.1.2-3v4JTR45UgbGg2k0qjmKpG" 'False) (C1 ('MetaCons "Opening" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: (C1 ('MetaCons "Closing" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: C1 ('MetaCons "SelfClosing" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))) |
Inline elements.
Constructors
Str Text | |
Space | |
SoftBreak | |
LineBreak | |
Emph Inlines | |
Strong Inlines | |
Code Text | |
Link Inlines Text Text | |
Image Inlines Text Text | |
Entity Text | |
RawHtml Text |
Instances
NFData Inline # | |||||
Defined in Cheapskate.Types | |||||
Data Inline # | |||||
Defined in Cheapskate.Types Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Inline -> c Inline # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Inline # toConstr :: Inline -> Constr # dataTypeOf :: Inline -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Inline) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Inline) # gmapT :: (forall b. Data b => b -> b) -> Inline -> Inline # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Inline -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Inline -> r # gmapQ :: (forall d. Data d => d -> u) -> Inline -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Inline -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Inline -> m Inline # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Inline -> m Inline # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Inline -> m Inline # | |||||
Generic Inline # | |||||
Defined in Cheapskate.Types Associated Types
| |||||
Show Inline # | |||||
type Rep Inline # | |||||
Defined in Cheapskate.Types type Rep Inline = D1 ('MetaData "Inline" "Cheapskate.Types" "cheapskate-0.1.1.2-3v4JTR45UgbGg2k0qjmKpG" 'False) (((C1 ('MetaCons "Str" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: C1 ('MetaCons "Space" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "SoftBreak" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "LineBreak" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Emph" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Inlines))))) :+: ((C1 ('MetaCons "Strong" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Inlines)) :+: (C1 ('MetaCons "Code" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: C1 ('MetaCons "Link" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Inlines) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))))) :+: (C1 ('MetaCons "Image" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Inlines) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))) :+: (C1 ('MetaCons "Entity" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: C1 ('MetaCons "RawHtml" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))))) |
Rendering and parsing options.
Constructors
Options | |
Fields
|
Instances
Default Options # | |||||
Defined in Cheapskate.Types | |||||
NFData Options # | |||||
Defined in Cheapskate.Types | |||||
Data Options # | |||||
Defined in Cheapskate.Types Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Options -> c Options # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Options # toConstr :: Options -> Constr # dataTypeOf :: Options -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Options) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Options) # gmapT :: (forall b. Data b => b -> b) -> Options -> Options # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Options -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Options -> r # gmapQ :: (forall d. Data d => d -> u) -> Options -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Options -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Options -> m Options # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Options -> m Options # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Options -> m Options # | |||||
Generic Options # | |||||
Defined in Cheapskate.Types Associated Types
| |||||
Show Options # | |||||
type Rep Options # | |||||
Defined in Cheapskate.Types type Rep Options = D1 ('MetaData "Options" "Cheapskate.Types" "cheapskate-0.1.1.2-3v4JTR45UgbGg2k0qjmKpG" 'False) (C1 ('MetaCons "Options" 'PrefixI 'True) ((S1 ('MetaSel ('Just "sanitize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "allowRawHtml") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "preserveHardBreaks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "debug") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)))) |