diff options
author | p4bl0 <pablo@rauzy.name> | 2010-07-24 13:22:39 +0200 |
---|---|---|
committer | p4bl0 <pablo@rauzy.name> | 2010-07-24 13:22:39 +0200 |
commit | 5ff0da0a719dd5e151004e41a5c18fbc7efb814a (patch) | |
tree | 19960024ea62e79b8bab336d4dda933b61caf924 /README | |
parent | 367a72ccb68a3131302f6951a7da15577f13228f (diff) |
added preprocessing possibilities for article (to enable use of Markdown, textile or whatever)
Diffstat (limited to 'README')
-rw-r--r-- | README | 39 |
1 files changed, 23 insertions, 16 deletions
@@ -14,7 +14,7 @@ fugitive README file <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 + Then 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 "fugitive". @@ -35,7 +35,7 @@ fugitive README file </p> <h3>Update</h3> <p> - Simply run <code>fugitive --install-hooks <dir></code>.<br /> + Run <code>fugitive --install-hooks <dir></code>.<br /> This will only (re)install fugitive hooks scripts.<br /> If <dir> isn't specified then the current working directory is used. </p> @@ -43,37 +43,44 @@ fugitive README file <h2>Configuration</h2> <p> - There are three item in the "fugitive" section of the git config: + There are three paths 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. + <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. </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 ".". + <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 + ".". </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 ".". + <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 + ".". </li> </ul> <p> <strong>NOTE:</strong> You must NOT put a trailing '/' at the end of any of those paths. </p> +<p> + If you want your article to be preprocessed by an external tool (markdown, + textile...) you need to set <em>preproc</em> to a command line that will take + the file path as argument and write to stdout. +</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). + <em>articles-dir</em> directory (see CONFIGURATION). </p> <p> The first line of the file will be used as title and the rest of the file as @@ -81,8 +88,8 @@ fugitive README file </p> <p> <strong>/!\ WARNINGS:</strong><br /> - DO NOT CREATE AN ARTICLE FILE NAMED "archives".<br /> - DO NOT CREATE AN ARTICLE FILE NAMED "index". + 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> |