Hakyll.Core.Configuration

Exports a datastructure for the top-level hakyll configuration

Documentation

data Configuration

Constructors

Configuration

Fields

• destinationDirectory :: FilePath

  Directory in which the output written

• storeDirectory :: FilePath

  Directory where hakyll's internal store is kept

• tmpDirectory :: FilePath

  Directory in which some temporary files will be kept

• providerDirectory :: FilePath

  Directory where hakyll finds the files to compile. This is . by default.

• ignoreFile :: FilePath -> Bool

  Function to determine ignored files

  In defaultConfiguration, the following files are ignored:

  • files starting with a .
  • files starting with a #
  • files ending with a ~
  • files ending with .swp

  Note that the files in destinationDirectory and storeDirectory will also be ignored. Note that this is the configuration parameter, if you want to use the test, you should use shouldIgnoreFile.

• checkHtmlFile :: FilePath -> Bool

  Function to determine HTML files whose links are to be checked.

  In defaultConfiguration, files with the .html extension are checked.

• watchIgnore :: FilePath -> Bool

  Function to determine files and directories that should not trigger a rebuild when touched in watch mode.

  Paths are passed in relative to the providerDirectory.

  All files that are ignored by ignoreFile are also always ignored by watchIgnore.

• deployCommand :: String

  Here, you can plug in a system command to upload/deploy your site.

  Example:

  rsync -ave 'ssh -p 2217' _site [e-mail]:hakyll

  You can execute this by using

  ./site deploy

• deploySite :: Configuration -> IO ExitCode

  Function to deploy the site from Haskell.

  By default, this command executes the shell command stored in deployCommand. If you override it, deployCommand will not be used implicitely.

  The Configuration object is passed as a parameter to this function.

• inMemoryCache :: Bool

  Use an in-memory cache for items. This is faster but uses more memory.

• previewHost :: String

  Override default host for preview server. Default is "127.0.0.1", which binds only on the loopback address. One can also override the host as a command line argument: ./site preview -h "0.0.0.0"

• previewPort :: Int

  Override default port for preview server. Default is 8000. One can also override the port as a command line argument: ./site preview -p 1234

• previewSettings :: FilePath -> StaticSettings

  Override other settings used by the preview server. Default is defaultFileServerSettings.

Instances

Default Configuration

Defined in Hakyll.Core.Configuration

Methods

def :: Configuration

shouldIgnoreFile :: Configuration -> FilePath -> IO Bool

Check if a file should be ignored

shouldWatchIgnore :: Configuration -> IO (FilePath -> IO Bool)

Returns a function to check if a file should be ignored in watch mode

defaultConfiguration :: Configuration

Default configuration for a hakyll application