hakyll-init

Generate a new Hakyll sample blog

$ hakyll-init [path/to/directory]

$ hakyll-init --help

hakyll-init [project-name]

project-name
    The name of the new Hakyll project. This will be the name of the directory created for the project. If not provided, the command might prompt you for one.

The hakyll-init command is a command-line tool provided by Hakyll, a static site generator library written in Haskell. It simplifies the process of creating a new Hakyll project by setting up the basic project structure and necessary files. This includes creating a default configuration file (usually site.hs), an input directory for content, and a default template directory. It streamlines the initial project setup, allowing users to quickly start developing their Hakyll-based static websites without having to manually create all the boilerplate code and directory structure. The command often interactively prompts the user to choose a project name and potentially a template for initial site layout. The command aims to provide an easy starting point for new users.

The command requires Hakyll to be installed and configured properly on the system. It also requires a Haskell development environment, including the GHC compiler and Cabal or Stack build tool. Make sure you are running the command with write permissions in the directory where you want to create the project.

hakyll-init often allows the user to choose from a set of pre-defined templates. These templates can provide starting points for different types of websites, such as blogs, documentation sites, or personal portfolios. The available templates may vary depending on the version of Hakyll installed.

After execution, hakyll-init creates a basic directory structure, including directories for source files (e.g., content), templates, and potentially static assets (e.g., CSS, JavaScript). The core configuration file, site.hs, contains the Hakyll site definition, specifying the build rules and routing logic for the static site.

hakyll-init was introduced as part of the Hakyll library to improve the user experience and make it easier for newcomers to start using the static site generator. It evolved alongside Hakyll, with updates and improvements being made to the templates and project setup procedures offered by the command. Its initial design was aimed at lowering the barrier to entry by automating the tedious initial configuration steps.

ghc(1), cabal(1), stack(1)