Shikensu.Contrib

Dictionary functions.

Documentation

clearMetadata :: Dictionary -> Dictionary

Clear metadata.

Replace the current hash map with an empty one.

clearMetadataDef :: Definition -> Definition

clone :: FilePath -> FilePath -> Dictionary -> Dictionary

Clone.

For each definition that has the given localPath (1st argument), make a clone with a new localPath (2nd argument), and add that into dictionary just after the matching definition.

clone "index.html" "200.html" dictionary

copyPropsToMetadata :: Dictionary -> Dictionary

Copy definition properties into the metadata.

See the toJSON implementation for Definition in Types to see what properties get put in here.

copyPropsToMetadataDef :: Definition -> Definition

exclude :: FilePath -> Dictionary -> Dictionary

Exclude.

Filter out the definitions that have the given localPath.

insertMetadata :: Metadata -> Dictionary -> Dictionary

Insert metadata.

Merge the current hash map with another one.

insertMetadataDef :: Metadata -> Definition -> Definition

permalink :: String -> Dictionary -> Dictionary

Permalink.

Append the basename to the dirname, and change the basename to the given string. It will NOT change definitions that already have the new basename.

permalink "index" dictionary

permalinkDef :: String -> Definition -> Definition

prefixDirname :: String -> Dictionary -> Dictionary

Prefix dirname.

Prefix the dirname of each definition with a given string.

prefixDirnameDef :: String -> Definition -> Definition

rename :: FilePath -> FilePath -> Dictionary -> Dictionary

Rename.

Change the localPath of the definitions that match a given localPath. For example, if you have a definition with the local path `abexample.html`:

rename "a/b/example.html" "example/index.html" dictionary

See localPath for more info.

renameDef :: FilePath -> FilePath -> Definition -> Definition

renameExt :: String -> String -> Dictionary -> Dictionary

Rename extension.

Example:

renameExt ".markdown" ".html" dictionary
-- The definitions that had the extname ".markdown"
-- now have the extname ".html"

renameExtDef :: String -> String -> Definition -> Definition

renderContent :: (Definition -> Maybe ByteString) -> Dictionary -> Dictionary

Render content.

Replace the content property by providing a renderer. A renderer is a function with the signature `Definition -> Maybe ByteString`.

You can use this to render templates, markdown, etc.

renderContentDef :: (Definition -> Maybe ByteString) -> Definition -> Definition

replaceMetadata :: Metadata -> Dictionary -> Dictionary

Replace metadata.

Replace the current hash map with another one.

replaceMetadataDef :: Metadata -> Definition -> Definition

setContent :: ByteString -> Dictionary -> Dictionary

Set content.

Set content directly.

setContentDef :: ByteString -> Definition -> Definition

transformContent :: (Definition -> Maybe ByteString) -> Dictionary -> Dictionary

Transform content.

Alias for renderContent.

transformContentDef :: (Definition -> Maybe ByteString) -> Definition -> Definition