Xrefcheck.Scanners.Markdown

Scanner for gathering references to verify from Markdown documents.

Documentation

data MarkdownConfig

Constructors

MarkdownConfig

Fields

• mcFlavor :: Flavor

Instances

FromJSON MarkdownConfig

Defined in Xrefcheck.Scanners.Markdown

Methods

parseJSON :: Value -> Parser MarkdownConfig

parseJSONList :: Value -> Parser [MarkdownConfig]

omittedField :: Maybe MarkdownConfig

Generic MarkdownConfig

Defined in Xrefcheck.Scanners.Markdown

Associated Types

type Rep MarkdownConfig :: Type -> Type

Methods

from :: MarkdownConfig -> Rep MarkdownConfig x

to :: Rep MarkdownConfig x -> MarkdownConfig

type Rep MarkdownConfig

Defined in Xrefcheck.Scanners.Markdown

type Rep MarkdownConfig = D1 ('MetaData "MarkdownConfig" "Xrefcheck.Scanners.Markdown" "xrefcheck-0.3.0-GeqFdwqv2mJ31qwgW3PUq5" 'False) (C1 ('MetaCons "MarkdownConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "mcFlavor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Flavor)))

defGithubMdConfig :: MarkdownConfig

markdownScanner :: Given PrintUnixPaths => MarkdownConfig -> ScanAction

markdownSupport :: Given PrintUnixPaths => MarkdownConfig -> FileSupport

parseFileInfo :: MarkdownConfig -> String -> Text -> (FileInfo, [ScanError 'Parse])

makeError :: FilePath -> Maybe PosInfo -> ScanErrorDescription -> [ScanError 'Parse]

Orphan instances

Buildable Node

Methods

build :: Node -> Builder