2010-07-24 04:25:34 +02:00
|
|
|
fugitive README file
|
|
|
|
|
|
|
|
<h2>Info</h2>
|
|
|
|
<p>
|
|
|
|
fugitive is a blog engine running on top of git using hooks to generate
|
|
|
|
static html pages and thus having only git as dependency.
|
|
|
|
</p>
|
|
|
|
|
|
|
|
<h2>Install</h2>
|
|
|
|
|
|
|
|
<h3>Build</h3>
|
|
|
|
<p>
|
|
|
|
If you want to build fugitive from the source, clone the git repository:
|
|
|
|
<br />
|
|
|
|
<code>git clone git://gitorious.org/fugitive/fugitive.git fugitive</code>
|
|
|
|
<br />
|
2010-07-24 13:22:39 +02:00
|
|
|
Then go in the newly created directory: <code>cd fugitive</code>, and
|
2010-07-24 04:25:34 +02:00
|
|
|
run the build script: <code>./build.sh</code>.
|
|
|
|
<br />
|
|
|
|
This will generate an executable file "fugitive".
|
|
|
|
</p>
|
|
|
|
<h3>Create a blog</h3>
|
|
|
|
<p>
|
|
|
|
If you have the "fugitive" executable file and want to start a new
|
|
|
|
blog: Run <code>fugitive --install <dir></code>.
|
|
|
|
<br />
|
|
|
|
This will create the git repos with appropriate hooks and files in
|
|
|
|
<dir>.
|
|
|
|
<br />
|
|
|
|
If <dir> isn't specified then the current working directory is used.
|
|
|
|
<p>
|
|
|
|
<p>
|
|
|
|
<strong>NOTE:</strong> You need to use the same process to install any remote
|
|
|
|
repository where you'd like to push your blog.
|
|
|
|
</p>
|
|
|
|
<h3>Update</h3>
|
|
|
|
<p>
|
2010-07-24 13:22:39 +02:00
|
|
|
Run <code>fugitive --install-hooks <dir></code>.<br />
|
2010-07-24 04:25:34 +02:00
|
|
|
This will only (re)install fugitive hooks scripts.<br />
|
|
|
|
If <dir> isn't specified then the current working directory is used.
|
|
|
|
</p>
|
|
|
|
|
|
|
|
<h2>Configuration</h2>
|
|
|
|
|
|
|
|
<p>
|
2010-07-24 13:22:39 +02:00
|
|
|
There are three paths in the "fugitive" section of the git config:
|
2010-07-24 04:25:34 +02:00
|
|
|
</p>
|
|
|
|
<ul>
|
|
|
|
<li>
|
2010-07-24 13:22:39 +02:00
|
|
|
<em>public-dir</em> is the path to the directory that will contain the
|
|
|
|
generated html files. Defautlt value is ".", the root of the git
|
|
|
|
repository. You could set it to "blog" for instance if you
|
|
|
|
already have a static website under your git repos.
|
2010-07-24 04:25:34 +02:00
|
|
|
</li>
|
|
|
|
<li>
|
2010-07-24 13:22:39 +02:00
|
|
|
<em>articles-dir</em> is the path where fugitive will look for published
|
|
|
|
articles. Default value is "_articles". This path is relative to
|
|
|
|
the root of the git repository, must be in it and must not start with
|
|
|
|
".".
|
2010-07-24 04:25:34 +02:00
|
|
|
</li>
|
|
|
|
<li>
|
2010-07-24 13:22:39 +02:00
|
|
|
<em>templates-dire</em> is the path where fugitive will look for templates
|
|
|
|
files. Default value is "_templates". This path is relative to
|
|
|
|
the root of the git repository, must be in it and must not start with
|
|
|
|
".".
|
2010-07-24 04:25:34 +02:00
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
<p>
|
|
|
|
<strong>NOTE:</strong> You must NOT put a trailing '/' at the end of any of
|
|
|
|
those paths.
|
|
|
|
</p>
|
2010-07-24 13:22:39 +02:00
|
|
|
<p>
|
|
|
|
If you want your article to be preprocessed by an external tool (markdown,
|
2010-07-24 13:51:43 +02:00
|
|
|
textile...) you need to set <em>preproc</em> to a command line that will read
|
|
|
|
on stdin and write to stdout.
|
2010-07-24 13:22:39 +02:00
|
|
|
</p>
|
2010-07-24 04:25:34 +02:00
|
|
|
|
|
|
|
<h2>Usage</h2>
|
|
|
|
|
|
|
|
<h3>General use</h3>
|
|
|
|
<p>
|
|
|
|
Article you want to publish should be file without the .html extension in the
|
2010-07-24 13:22:39 +02:00
|
|
|
<em>articles-dir</em> directory (see CONFIGURATION).
|
2010-07-24 04:25:34 +02:00
|
|
|
</p>
|
|
|
|
<p>
|
|
|
|
The first line of the file will be used as title and the rest of the file as
|
|
|
|
the content.
|
|
|
|
</p>
|
|
|
|
<p>
|
|
|
|
<strong>/!\ WARNINGS:</strong><br />
|
2010-07-24 13:22:39 +02:00
|
|
|
DO NOT CREATE AN ARTICLE FILE NAMED "archives".<br />
|
|
|
|
DO NOT CREATE AN ARTICLE FILE NAMED "index".
|
2010-07-24 04:25:34 +02:00
|
|
|
</p>
|
|
|
|
<h3>Template system</h3>
|
|
|
|
<p><em>*TODO*</em></p>
|