Shakebook.Data

Documentation

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 t => Display [WithinDisplay a t]

Defined in Shakebook.Data

Methods

display :: [WithinDisplay a t] -> Utf8Builder

textDisplay :: [WithinDisplay a t] -> Text

Display t => Display (WithinDisplay a t)

Defined in Shakebook.Data

Methods

display :: WithinDisplay a t -> Utf8Builder

textDisplay :: WithinDisplay a t -> Text

data SbConfig

Constructors

SbConfig

Fields

• sbSrcDir :: Path Rel Dir
• sbOutDir :: Path Rel Dir
• sbBaseUrl :: Text
• sbMdRead :: ReaderOptions
• sbHTWrite :: WriterOptions
• sbPPP :: Int
• sbGlobalApply :: Value -> Value

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

class HasSbConfig a where

Methods

sbConfigL :: Lens' a SbConfig

Instances

HasSbConfig ShakebookEnv

Defined in Shakebook.Data

Methods

sbConfigL :: Lens' ShakebookEnv SbConfig

viewSrcPath :: Value -> Text

View the "src-path" field of a JSON Value.

withSrcPath :: Text -> Value -> Value

Add "src-path" field based on input Text.

viewBaseUrl :: Value -> Text

View the "base-url" of a JSON Value.

withBaseUrl :: Text -> Value -> Value

Add "base-url" field from input Text.

viewFullUrl :: Value -> Text

View the "full-url" of a JSON Value.

withFullUrl :: Text -> Value -> Value

Add "full-url" field from input Text.

viewImage :: Value -> Text

View the "image" field of a JSON vaule.

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 'src-path' 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)

withHaskellExtension :: 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

loadMarkdownAsJSON :: (MonadReader r m, HasSbConfig r, MonadAction m, MonadThrow m) => Within Rel (Path Rel File) -> m Value

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

immediateShoots :: Cofree [] a -> [a]