diff options
author | Jasper Van der Jeugt <jaspervdj@gmail.com> | 2011-06-13 18:26:04 +0200 |
---|---|---|
committer | Jasper Van der Jeugt <jaspervdj@gmail.com> | 2011-06-13 18:26:04 +0200 |
commit | efab53729d95cc69a8205bb691db9c12e9e06096 (patch) | |
tree | 30def121f2d7907ffa8e7ebbdca7b213fc8b3016 /web/tutorials/faq.markdown | |
parent | ea694663e1e2ed2781001996c0a2cc2c2e5fdbbb (diff) | |
download | hakyll-efab53729d95cc69a8205bb691db9c12e9e06096.tar.gz |
Update website a bit
Diffstat (limited to 'web/tutorials/faq.markdown')
-rw-r--r-- | web/tutorials/faq.markdown | 53 |
1 files changed, 53 insertions, 0 deletions
diff --git a/web/tutorials/faq.markdown b/web/tutorials/faq.markdown new file mode 100644 index 0000000..f8a3087 --- /dev/null +++ b/web/tutorials/faq.markdown @@ -0,0 +1,53 @@ +--- +title: FAQ +--- + +## Does Hakyll support syntax highlighting? + +Syntax highlighting is enabled by default in Hakyll. However, you also need to +enable it in pandoc. If no syntax highlighting shows up, try + + [jasper@phoenix] cabal install --reinstall -fhighlighting pandoc + +## When should I rebuild and when should I build? + +If you execute a `./hakyll build`, Hakyll will build your site incrementally. +This means it will be very fast, but it will not pick up _all_ changes. + +- In case you edited `hakyll.hs`, you first want to compile it again. +- It is generally recommended to do a `./hakyll rebuild` before you deploy your + site. + +After rebuilding your site, all files will look as "modified" to the filesystem. +This means that when you upload your site, it will usually transfer all files -- +this can generate more traffic than necessary, since it is possible that some +files were not actually modified. If you use `rsync`, you can counter this using +the `--checksum` option. + +## Problem with regex-pcre dependency on Mac OS + +Hakyll requires [regex-pcre], which might fail to build on Mac OS. To solve +this problem, make sure the [pcre] C library is installed (via homebrew or +macports). Then install [regex-pcre] using: + + cabal install --extra-include-dirs=/usr/local/include regex-pcre + +or + + cabal install --extra-include-dirs=/opt/local/include regex-pcre + +...and proceed to install Hakyll the regular way. + +[regex-pcre]: http://hackage.haskell.org/package/regex-pcre +[pcre]: http://www.pcre.org/ + +## "File name does not match module name" on Mac OS + + Hakyll.hs:1:1: + File name does not match module name: + Saw: `Main' + Expected: `Hakyll' + +Is an error encountered on Mac OS when `hakyll.hs` is located on a +case-insensitive filesystem. A workaround is to rename it to something that +isn't the name of the module, for example, `site.hs`. |