Shakebook.Data

Documentation

needLocalOut :: (MonadAction m, MonadReader r m, HasLocalOut r) => [Path Rel File] -> m ()

(%->) :: (MonadReader r m, MonadRules m, HasLocalOut r) => FilePattern -> (Within Rel File -> RAction r ()) -> m ()

class HasLocalOut r where

Methods

localOutL :: Lens' r (Path Rel Dir)

Instances

HasLocalOut ShakebookEnv

Defined in Shakebook.Data

Methods

localOutL :: Lens' ShakebookEnv (Path Rel Dir)

class HasLocalSrc r where

Methods

localSrcL :: Lens' r (Path Rel Dir)

newtype PathDisplay a t

Constructors

PathDisplay (Path a t)

Instances

Display (PathDisplay a t)

Defined in Shakebook.Data

Methods

display :: PathDisplay a t -> Utf8Builder

textDisplay :: PathDisplay a t -> Text

newtype WithinDisplay a t

Constructors

WithinDisplay (Within a t)

Instances

Display [WithinDisplay a t]

Defined in Shakebook.Data

Methods

display :: [WithinDisplay a t] -> Utf8Builder

textDisplay :: [WithinDisplay a t] -> Text

Display (WithinDisplay a t)

Defined in Shakebook.Data

Methods

display :: WithinDisplay a t -> Utf8Builder

textDisplay :: WithinDisplay a t -> Text

type ToC = Cofree [] String

data SbConfig

Constructors

SbConfig

Fields

• sbSrcDir :: Path Rel Dir
• sbOutDir :: Path Rel Dir
• sbBaseUrl :: Text
• sbMdRead :: ReaderOptions
• sbHTWrite :: WriterOptions
• sbPPP :: Int

Instances

Show SbConfig

Defined in Shakebook.Data

Methods

showsPrec :: Int -> SbConfig -> ShowS

show :: SbConfig -> String

showList :: [SbConfig] -> ShowS

class HasSbConfig a where

Methods

sbConfigL :: Lens' a SbConfig

Instances

HasSbConfig ShakebookEnv

Defined in Shakebook.Data

Methods

sbConfigL :: Lens' ShakebookEnv SbConfig

data ShakebookEnv

Constructors

ShakebookEnv

Fields

• logFunc :: LogFunc
• sbConfig :: SbConfig

Instances

HasLogFunc ShakebookEnv

Defined in Shakebook.Data

Methods

logFuncL :: Lens' ShakebookEnv LogFunc

HasSbConfig ShakebookEnv

Defined in Shakebook.Data

Methods

sbConfigL :: Lens' ShakebookEnv SbConfig

HasLocalOut ShakebookEnv

Defined in Shakebook.Data

Methods

localOutL :: Lens' ShakebookEnv (Path Rel Dir)

viewSrcPath :: Value -> Text

View the "srcPath" field of a JSON Value.

withSrcPath :: Text -> Value -> Value

Add "srcPath" field based on input Text.

withBaseUrl :: Text -> Value -> Value

Add "baseUrl" field from input Text.

withFullUrl :: Text -> Value -> Value

Add "fullUrl" field from input Text.

viewUrl :: Value -> Text

View the "url" field of a JSON Value.

withUrl :: Text -> Value -> Value

Add "url" field from input Text.

enrichFullUrl :: Text -> Value -> Value

Assuming a "url" field, enrich via a baseURL

enrichUrl :: (Text -> Text) -> Value -> Value

Assuming a srcPath field, enrich using withUrl using a Text -> Text transformation.

leadingSlash :: Path Abs Dir

withHtmlExtension :: MonadThrow m => Path Rel File -> m (Path Rel File)

withMarkdownExtension :: MonadThrow m => Path Rel File -> m (Path Rel File)

generateSupposedUrl :: MonadThrow m => Path Rel File -> m (Path Abs File)

enrichSupposedUrl :: (MonadReader r m, HasSbConfig r, MonadThrow m) => Value -> m Value

readMarkdownFile' :: (MonadReader r m, HasSbConfig r, MonadAction m) => Within Rel File -> m Value

Get a JSON Value of Markdown Data with markdown body as "contents" field and the srcPath as "srcPath" field.

data PaginationException

Constructors

EmptyContentsError

Instances

Eq PaginationException

Defined in Shakebook.Data

Methods

(==) :: PaginationException -> PaginationException -> Bool

(/=) :: PaginationException -> PaginationException -> Bool

Show PaginationException

Defined in Shakebook.Data

Methods

showsPrec :: Int -> PaginationException -> ShowS

show :: PaginationException -> String

showList :: [PaginationException] -> ShowS

Exception PaginationException

Defined in Shakebook.Data

Methods

toException :: PaginationException -> SomeException

fromException :: SomeException -> Maybe PaginationException

displayException :: PaginationException -> String

paginate' :: MonadThrow m => Int -> [a] -> m (Zipper [] [a])

lower :: Cofree [] Value -> [Value]

type MonadShakebook r m = (MonadReader r m, HasSbConfig r, HasLogFunc r, MonadIO m, MonadThrow m, HasLocalOut r)

type MonadShakebookAction r m = (MonadShakebook r m, MonadAction m)

type MonadShakebookRules r m = (MonadShakebook r m, MonadRules m)

loadSortFilterEnrich

Arguments

:: (MonadShakebookAction r m, Ord b)

=> [FilePattern]

A shake filepattern to load, relative to srcDir from SbConfig.

-> (Value -> b)

A value to sortOn e.g (Down . viewPostTime)

-> (Value -> Bool)

A filtering predicate e.g (elem tag . viewTags)

-> (Value -> Value)

An initial enrichment. This is pure so can only be data derived from the initial markdown.

-> m [(Within Rel File, Value)]

A list of Values indexed by their srcPath.

Multi-markdown loader. Allows you to load a filepattern of markdown as a list of JSON values ready to pass to an HTML template. You will probably want to add additional data before you write. See the examples in Shakebook.Defaults

loadSortEnrich

Arguments

:: (MonadShakebookAction r m, Ord b)

=> [FilePattern]

A Shake filepattern to load.

-> (Value -> b)

A value to sortOn e.g (Down . viewPostTime).

-> (Value -> Value)

An initial pure enrichment.

-> m [(Within Rel File, Value)]

A list of Values index by their srcPath.

The same as loadSortFilterEnrich but without filtering.