hakyll-4.16.0.0: A static website compiler library
Safe HaskellSafe-Inferred
LanguageHaskell2010

Hakyll.Main

Description

Module providing the main hakyll function and command-line argument parsing

Synopsis

Entry points

hakyll :: Rules a -> IO () Source #

This usually is the function with which the user runs the hakyll compiler

hakyllWith :: Configuration -> Rules a -> IO () Source #

A variant of hakyll which allows the user to specify a custom configuration

hakyllWithArgs :: Configuration -> Options -> Rules a -> IO () Source #

A variant of hakyll which expects a Configuration and command-line Options. This gives freedom to implement your own parsing.

hakyllWithExitCode :: Configuration -> Rules a -> IO ExitCode Source #

A variant of hakyll which returns an ExitCode

Command line argument parsers

data Options Source #

The parsed command-line options.

Constructors

Options 

Instances

Instances details
Show Options Source # 
Instance details

Defined in Hakyll.Main

data Command Source #

The command to run.

Constructors

Build RunMode

Generate the site.

Check

Validate the site output.

Fields

Clean

Clean up and remove cache.

Deploy

Upload/deploy your site.

Preview

Deprecated: Use Watch instead.

DEPRECATED
Please use the watch command.

Fields

Rebuild

Clean and build again.

Server

Start a preview server.

Fields

Watch

Autocompile on changes and start a preview server.

Fields

Instances

Instances details
Show Command Source # 
Instance details

Defined in Hakyll.Main