| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Rib.Shake
Description
Combinators for working with Shake.
Synopsis
- buildStaticFiles :: [Path Rel File] -> Action ()
- buildHtmlMulti :: SourceReader repr -> [Path Rel File] -> (Source repr -> Html ()) -> Action [Source repr]
- buildHtml :: SourceReader repr -> Path Rel File -> Path Rel File -> (Source repr -> Html ()) -> Action (Source repr)
- buildHtml_ :: SourceReader repr -> Path Rel File -> Path Rel File -> (Source repr -> Html ()) -> Action ()
- readSource :: SourceReader repr -> Path Rel File -> Action repr
- writeHtml :: Path Rel File -> Html () -> Action ()
- data RibSettings = RibSettings {}
- ribInputDir :: Action (Path Rel Dir)
- ribOutputDir :: Action (Path Rel Dir)
- getDirectoryFiles' :: Path b Dir -> [Path Rel File] -> Action [Path Rel File]
Basic helpers
Arguments
| :: SourceReader repr | How to parse the source file |
| -> [Path Rel File] | Source file patterns (relative to |
| -> (Source repr -> Html ()) | How to render the given source to HTML |
| -> Action [Source repr] | Result |
Convert the given pattern of source files into their HTML.
Arguments
| :: SourceReader repr | |
| -> Path Rel File | Path to the output HTML file (relative to |
| -> Path Rel File | Path to the source file (relative to |
| -> (Source repr -> Html ()) | |
| -> Action (Source repr) |
Like buildHtmlMulti but operate on a single file.
Also explicitly takes the output file path.
buildHtml_ :: SourceReader repr -> Path Rel File -> Path Rel File -> (Source repr -> Html ()) -> Action () Source #
Like buildHtml but discards its result.
Reading only
Arguments
| :: SourceReader repr | How to parse the source |
| -> Path Rel File | Path to the source file (relative to |
| -> Action repr |
Read and parse an individual source file
Writing only
writeHtml :: Path Rel File -> Html () -> Action () Source #
Write a single HTML file with the given HTML value
The HTML text value will be cached, so subsequent writes of the same value will be skipped.
Misc
data RibSettings Source #
RibSettings is initialized with the values passed to run
Constructors
| RibSettings | |
Fields | |