| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Rib.Shake
Contents
Description
Combinators for working with Shake.
The functions in this module work with ribInputDir and ribOutputDir.
See the source of buildAction for example usage.
Synopsis
- buildHtmlMulti :: (FilePattern, ReaderOptions -> Text -> PandocIO Pandoc) -> ((FilePath, Pandoc) -> Html ()) -> Action [(FilePath, Pandoc)]
- buildHtml :: FilePath -> Html () -> Action ()
- readPandoc :: (ReaderOptions -> Text -> PandocIO Pandoc) -> FilePath -> Action Pandoc
- readPandocMulti :: (FilePattern, ReaderOptions -> Text -> PandocIO Pandoc) -> Action [(FilePath, Pandoc)]
- buildStaticFiles :: [FilePattern] -> Action [FilePath]
Basic helpers
Arguments
| :: (FilePattern, ReaderOptions -> Text -> PandocIO Pandoc) | Source file patterns & their associated Pandoc readers |
| -> ((FilePath, Pandoc) -> Html ()) | How to render the given Pandoc document to HTML |
| -> Action [(FilePath, Pandoc)] | List of relative path to generated HTML and the associated Pandoc document |
Convert the given pattern of source files into their HTML.
Read helpers
Arguments
| :: (ReaderOptions -> Text -> PandocIO Pandoc) | Document format. Example: |
| -> FilePath | |
| -> Action Pandoc |
Read and parse a Pandoc source document
If an associated metadata file exists (same filename, with .yaml as
extension), use it to specify the metadata of the document.
Arguments
| :: (FilePattern, ReaderOptions -> Text -> PandocIO Pandoc) | Tuple of pattern of files to work on and document format. |
| -> Action [(FilePath, Pandoc)] |
Like readPandoc but operates on multiple files
Misc
buildStaticFiles :: [FilePattern] -> Action [FilePath] Source #
Shake action to copy static files as is