README


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88

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 />
  Then simply go in the newly created directory: <code>cd fugitive</code>, and
  run the build script: <code>./build.sh</code>.
  <br />
  This will generate an executable file &quot;fugitive&quot;.
</p>
<h3>Create a blog</h3>
<p>
  If you have the &quot;fugitive&quot; executable file and want to start a new
  blog: Run <code>fugitive --install &lt;dir&gt;</code>.
  <br />
  This will create the git repos with appropriate hooks and files in
  &lt;dir&gt;.
  <br />
  If &lt;dir&gt; 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>
  Simply run <code>fugitive --install-hooks &lt;dir&gt;</code>.<br />
  This will only (re)install fugitive hooks scripts.<br />
  If &lt;dir&gt; isn't specified then the current working directory is used.
</p>

<h2>Configuration</h2>

<p>
  There are three item in the "fugitive" section of the git config:
</p>
<ul>
  <li>
    "public-dir" 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.
  </li>
  <li>
    "articles-dir" 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 ".".
  </li>
  <li>
    "templates-dir" 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 ".".
  </li>
</ul>
<p>
  <strong>NOTE:</strong> You must NOT put a trailing '/' at the end of any of
  those paths.
</p>

<h2>Usage</h2>

<h3>General use</h3>
<p>
  Article you want to publish should be file without the .html extension in the
  "articles-dir" directory (see CONFIGURATION).
</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 />
  DO NOT CREATE AN ARTICLE FILE NAMED "archives".<br />
  DO NOT CREATE AN ARTICLE FILE NAMED "index".
</p>
<h3>Template system</h3>
<p><em>*TODO*</em></p>