Shakebook.Conventions

Conventions used for common shakebook projects, lenses, enrichments, affixes.

Lenses

viewContent :: Value -> Text

View the "content" field of a JSON Value.

viewPostTime :: Value -> UTCTime

View the "date" field of a JSON Value as a UTCTime.

viewPostTimeRaw :: Value -> Text

View the "date" field of a JSON Value as Text.

viewSrcPath :: Value -> Text

View the "srcPath" field of a JSON Value.

viewTags :: Value -> [Text]

View the "tags" field of a JSON Value as a list.

viewTitle :: Value -> Text

View the "title" field of a JSON Value.

viewAllPostTags :: [Value] -> [Text]

View all post tags for a list of posts.

viewAllPostTimes :: [Value] -> [UTCTime]

View all posts times for a list of posts.

withHighlighting :: Style -> Value -> Value

Add "highlighting-css" field from input Style.

withNext :: Maybe Value -> Value -> Value

Add "next" field from input Value.

withPages :: [Value] -> Value -> Value

Add "pages" field from input [Value].

withPrettyDate :: Text -> Value -> Value

Add "prettydate" field using input Text.

withPrevious :: Maybe Value -> Value -> Value

Add "previous" field using input Value.

withPosts :: [Value] -> Value -> Value

Add "posts" field based on input [Value].

withRecentPosts :: [Value] -> Value -> Value

Add "recentposts" field using input Value.

withSrcPath :: Text -> Value -> Value

Add "srcPath" field based on input Text.

withSubsections :: [Value] -> Value -> Value

Add "subsections" field based on inpt [Value].

withTagIndex :: [Value] -> Value -> Value

Add "tagindex" field based on input [Value].

withTagLinks :: [Value] -> Value -> Value

Add "taglinks" field based on input [Value].

withTeaser :: Text -> Value -> Value

Add "teaser" field based on input Text.

withTitle :: Text -> Value -> Value

Add "title" field based on input Text.

Enrichments

enrichPrettyDate :: (UTCTime -> String) -> Value -> Value

Assuming a "date" field, enrich using withPrettyDate and a format string.

enrichTagLinks :: (Text -> Text) -> Value -> Value

Assuming a "tags" field, enrich using withTagLinks.

enrichTeaser :: Text -> Value -> Value

Assuming a "content" field with a spitter section, enrich using withTeaser

Extensions

extendNext :: Zipper [] Value -> Zipper [] Value

Extend a Zipper of JSON Values to add "next" objects.

extendPrevious :: Zipper [] Value -> Zipper [] Value

Extend a Zipper of JSON Values to add "previous" objects.

extendNextPrevious :: Zipper [] Value -> Zipper [] Value

Add both "next" and "previous" fields using withPostNext and withPostPrevious

extendPageNeighbours :: Int -> Zipper [] Value -> Zipper [] Value

Generations

genBlogNavbarData

Arguments

:: Text

"Top level title, e.g Blog

-> Text

Root page, e.g "/posts"

-> (UTCTime -> Text)

Formatting function to a UTCTime to a title.

-> (UTCTime -> Text)

Formatting function to convert a UTCTime to a URL link

-> [Value]

-> Value

Create a blog navbar object for a posts section, with layers "toc1", "toc2", and "toc3".

genIndexPageData :: MonadThrow m => [Value] -> Text -> (Text -> Text) -> Int -> m (Zipper [] Value)

genLinkData :: Text -> (Text -> Text) -> Value

Create link data object with fields "id" and "url" using an id and a function | transforming an id into a url.

genPageData :: Text -> (Text -> Text) -> Zipper [] [Value] -> Value

genTocNavbarData :: Cofree [] Value -> Value

Create a toc navbar object for a docs section, with layers "toc1", "toc2" and "toc3".

dateSortPosts :: [Value] -> [Value]

Sort a lists of posts by date.

monthFilterPosts :: UTCTime -> [Value] -> [Value]

sameMonth :: UTCTime -> UTCTime -> Bool

Check whether two posts were posted in the same month.

tagFilterPosts :: Text -> [Value] -> [Value]

Filter a lists of posts by tag.