hakyll/web/tutorials/01-installation.markdown
Thomas Koch 56de1d069d s/--local-bin-path/--local-bin/
output of `stack path --local-bin-path`:

```
Run from outside a project, using implicit global project config
Using resolver: lts-6.8 from implicit global project's config file: /home/REDACTED/.stack/global-project/stack.yaml

'--local-bin-path' will be removed in a future release.
Please use '--local-bin' instead.
```
2016-07-23 12:06:42 +02:00

51 lines
1.4 KiB
Markdown

---
title: Installation
author: Jasper Van der Jeugt
---
Installation
------------
Installation is provided via Hackage, and some packages are available for
different distributions. For installation from source (i.e. via Hackage),
[stack] is recommended:
$ stack install hakyll
[stack]: http://www.haskellstack.org/
Linux distro packages:
- [Debian unstable](http://packages.debian.org/source/sid/haskell-hakyll)
Building the example site
-------------------------
Apart from the main Hakyll library, the cabal package also provides you with an
executable `hakyll-init` to create an example site. This is an easy way to get
started:
$ hakyll-init my-site
This creates a folder `my-site` in the current directory, with some example
content and a generic configuration.
If `hakyll-init` is not found, you should make sure your stack bin path
(usually `$HOME/.local/bin`) is in your `$PATH`. You can check your stack local
bin path by running `stack path --local-bin`.
The file `site.hs` holds the configuration of your site, as an executable
haskell program. We can compile and run it like this:
$ cd my-site
$ stack init # Optional, if you haven't used stack before
$ stack build
$ stack exec site build
If you installed `hakyll` with a preview server (this is the default), you can
now use
$ stack exec site watch
and have a look at your site at
[http://localhost:8000/](http://localhost:8000/).