fugitive README file

Info

fugitive is a blog engine running on top of git using hooks to generate static html pages and thus having only git as dependency.

Install

Build

If you want to build fugitive from the source, clone the git repository:
git clone git://gitorious.org/fugitive/fugitive.git fugitive
Then go in the newly created directory: cd fugitive, and run the build script: ./build.sh.
This will generate an executable file "fugitive".

Create a blog

If you have the "fugitive" executable file and want to start a new blog: Run fugitive --install <dir>.
This will create the git repos with appropriate hooks and files in <dir>.
If <dir> isn't specified then the current working directory is used.

NOTE: You need to use the same process to install any remote repository where you'd like to push your blog.

Update

Run fugitive --install-hooks <dir>.
This will only (re)install fugitive hooks scripts.
If <dir> isn't specified then the current working directory is used.

Configuration

There are three paths in the "fugitive" section of the git config:

NOTE: You must NOT put a trailing '/' at the end of any of those paths.

If you want your article to be preprocessed by an external tool (markdown, textile...) you need to set preproc to a command line that will read on stdin and write to stdout.

Usage

General use

Article you want to publish should be file without the .html extension in the articles-dir directory (see CONFIGURATION).

The first line of the file will be used as title and the rest of the file as the content.

/!\ WARNINGS:
DO NOT CREATE AN ARTICLE FILE NAMED "archives".
DO NOT CREATE AN ARTICLE FILE NAMED "index".

Template system

*TODO*