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


-- | Static site generator based on Shake
--   
--   Haskell static site generator based on Shake, with a delightful
--   development experience.
@package rib
@version 1.0.0.0


-- | Some commonly useful CSS styles
module Rib.Extra.CSS

-- | Stock CSS for the <a>kbd</a> element
--   
--   Based on the MDN demo at,
--   <a>https://developer.mozilla.org/en-US/docs/Web/HTML/Element/kbd</a>
mozillaKbdStyle :: Css

-- | Include the specified Google Fonts
googleFonts :: Monad m => [Text] -> HtmlT m ()

-- | Include the specified stylesheet URL
stylesheet :: Monad m => Text -> HtmlT m ()


-- | Meta tags for The Open Graph protocol: <a>https://ogp.me/</a>
module Rib.Extra.OpenGraph
data OpenGraph
OpenGraph :: Text -> Maybe URI -> Maybe Text -> Maybe Text -> Text -> Maybe OGType -> Maybe URI -> OpenGraph
[_openGraph_title] :: OpenGraph -> Text
[_openGraph_url] :: OpenGraph -> Maybe URI
[_openGraph_author] :: OpenGraph -> Maybe Text
[_openGraph_description] :: OpenGraph -> Maybe Text
[_openGraph_siteName] :: OpenGraph -> Text
[_openGraph_type] :: OpenGraph -> Maybe OGType
[_openGraph_image] :: OpenGraph -> Maybe URI
data OGType
OGType_Article :: Article -> OGType
OGType_Website :: OGType
data Article
Article :: Maybe Text -> Maybe UTCTime -> Maybe UTCTime -> Maybe UTCTime -> [Text] -> Article
[_article_section] :: Article -> Maybe Text
[_article_modifiedTime] :: Article -> Maybe UTCTime
[_article_publishedTime] :: Article -> Maybe UTCTime
[_article_expirationTime] :: Article -> Maybe UTCTime
[_article_tag] :: Article -> [Text]
instance GHC.Show.Show Rib.Extra.OpenGraph.OpenGraph
instance GHC.Classes.Eq Rib.Extra.OpenGraph.OpenGraph
instance GHC.Show.Show Rib.Extra.OpenGraph.OGType
instance GHC.Classes.Eq Rib.Extra.OpenGraph.OGType
instance GHC.Show.Show Rib.Extra.OpenGraph.Article
instance GHC.Classes.Eq Rib.Extra.OpenGraph.Article
instance Lucid.Base.ToHtml Rib.Extra.OpenGraph.OpenGraph
instance Lucid.Base.ToHtml Rib.Extra.OpenGraph.OGType
instance Lucid.Base.ToHtml Rib.Extra.OpenGraph.Article


-- | Parser for Dhall configuration files.
--   
--   Use <a>makeHaskellTypes</a> to create the Haskell type first. And then
--   call <a>parse</a> from your Shake action.
module Rib.Parser.Dhall

-- | Parse a Dhall file as Haskell type.
parse :: FromDhall a => [FilePath] -> FilePath -> Action a


-- | Parsing Markdown using the mmark parser.
module Rib.Parser.MMark

-- | Parse Markdown using mmark
parse :: FilePath -> Action MMark

-- | Pure version of <a>parse</a>
parsePure :: FilePath -> Text -> Either Text MMark

-- | Like <a>parse</a> but takes a custom list of MMark extensions
parseWith :: [Extension] -> FilePath -> Action MMark

-- | Like <a>parsePure</a> but takes a custom list of MMark extensions
parsePureWith :: [Extension] -> FilePath -> Text -> Either Text MMark
defaultExts :: [Extension]

-- | Render a MMark document as HTML
render :: Monad m => MMark -> HtmlT m ()

-- | Get the first image in the document if one exists
getFirstImg :: MMark -> Maybe URI

-- | Get the first paragraph text of a MMark document.
--   
--   Useful to determine "preview" of your notes.
getFirstParagraphText :: MMark -> Maybe Text

-- | Extract contents of an optional YAML block that may have been parsed.
projectYaml :: MMark -> Maybe Value

-- | Representation of complete markdown document. You can't look inside of
--   <a>MMark</a> on purpose. The only way to influence an <a>MMark</a>
--   document you obtain as a result of parsing is via the extension
--   mechanism.
data MMark


-- | Helpers for working with Pandoc documents
module Rib.Parser.Pandoc

-- | Parse a lightweight markup language using Pandoc
parse :: (ReaderOptions -> Text -> PandocIO Pandoc) -> FilePath -> Action Pandoc

-- | Pure version of <a>parse</a>
parsePure :: (ReaderOptions -> Text -> PandocPure Pandoc) -> Text -> Pandoc

-- | Render a Pandoc document to HTML
render :: Monad m => Pandoc -> HtmlT m ()

-- | Render a list of Pandoc <a>Inline</a> values as Lucid HTML
--   
--   Useful when working with <a>Meta</a> values from the document
--   metadata.
renderPandocInlines :: Monad m => [Inline] -> HtmlT m ()

-- | Extract the Pandoc metadata as JSON value
extractMeta :: Pandoc -> Maybe (Either Text Value)

-- | Get the top-level heading as Lucid HTML
getH1 :: Monad m => Pandoc -> Maybe (HtmlT m ())

-- | Get the document table of contents
getToC :: Monad m => Pandoc -> HtmlT m ()

-- | Get the first image in the document if one exists
getFirstImg :: Pandoc -> Maybe Text
data Pandoc


module Rib

-- | Representation of complete markdown document. You can't look inside of
--   <a>MMark</a> on purpose. The only way to influence an <a>MMark</a>
--   document you obtain as a result of parsing is via the extension
--   mechanism.
data MMark
data Pandoc