gitit

Gitit
=====

Gitit is a wiki program written in Haskell. It uses [Happstack] for
the web server and [pandoc] for markup processing. Pages and uploaded
files are stored in a [git], [darcs], or [mercurial] repository
and may be modified either by using the VCS's command-line tools or
through the wiki's web interface. By default, pandoc's extended version
of markdown is used as a markup language, but reStructuredText, LaTeX, HTML,
DocBook, or Emacs Org-mode markup can also be used.  Gitit can
be configured to display TeX math (using [texmath]) and
highlighted source code (using [skylighting]).

Other features include

* plugins: dynamically loaded page transformations written in Haskell
  (see "Network.Gitit.Interface")

* categories

* TeX math

* syntax highlighting of source code files and code snippets.

* caching

* Atom feeds (site-wide and per-page)

* a library, "Network.Gitit", that makes it simple to include a gitit
  wiki in any happstack application

[git]: http://git.or.cz
[darcs]: http://darcs.net
[mercurial]: http://mercurial.selenic.com/
[pandoc]: http://pandoc.org
[Happstack]: http://happstack.com
[skylighting]: https://hackage.haskell.org/package/skylighting
[texmath]: http://github.com/jgm/texmath/tree/master

Getting started
===============

Compiling and installing gitit
------------------------------

The most reliable way to install gitit from source is to get the
[stack] tool.  Then clone the gitit repository and use stack
to install:

    git clone https://github.com/jgm/gitit
    cd gitit
    stack install

Alternatively, instead of using [stack], you can get the
[Haskell Platform] and do the following:

    cabal update
    cabal install gitit

This will install the latest released version of gitit.
To install a version of gitit checked out from the repository,
change to the gitit directory and type:

    cabal install

The `cabal` tool will automatically install all of the required haskell
libraries. If all goes well, by the end of this process, the latest
release of gitit will be installed in your local `.cabal` directory. You
can check this by trying:

    gitit --version

If that doesn't work, check to see that `gitit` is in your local
cabal-install executable directory (usually `~/.cabal/bin`). And make
sure `~/.cabal/bin` is in your system path.

[stack]: https://github.com/commercialhaskell/stack
[Haskell Platform]: https://www.haskell.org/platform/

Running gitit
-------------

To run gitit, you'll need `git` in your system path. (Or `darcs` or
`hg`, if you're using darcs or mercurial to store the wiki data.)

Gitit assumes that the page files (stored in the git repository) are
encoded as UTF-8. Even page names may be UTF-8 if the file system
supports this. So you should make sure that you are using a UTF-8 locale
when running gitit. (To check this, type `locale`.)

Switch to the directory where you want to run gitit. This should be a
directory where you have write access, since three directories, `static`,
`templa