aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md43
1 files changed, 42 insertions, 1 deletions
diff --git a/README.md b/README.md
index 1df51f5..6d737a0 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,45 @@
1FoldaWeb 1FoldaWeb
2======== 2========
3 3
4A tree structure based website generator. 4### Description
5
6FoldaWeb is a "keep last legacy" website generator: the program generates a page from parts of pages that are presents inside a directory and directly inside its parents. If multiple parts have the same name, it uses the last one (the one located the deepest in the directories before the current included).
7
8This behaviour makes particularly easy to create well-organized websites with many subpages of different types with associated layouts for each.
9
10___
11
12### Features
13
14- Unique "keep last legacy" generation (no pun intended)
15- Mustache templating: FoldaWeb uses [Mustache](http://mustache.github.io/mustache.5.html) as template engine and adds several handy contextual variables
16- Markdown compatible: pages can be written using the [Markdown syntax](http://daringfireball.net/projects/markdown/syntax)
17
18Moreover, because FoldaWeb generates static files, generated websites are:
19
20- **Portable**: any host and web server software can serve flat files.
21- **Fast**: no server-side scripting is required everytime someone loads a page
22- **Secure**: no CMS security flaws
23
24___
25
26### Example
27
28[Multiverse Inc. Global Website](http://multiverse.pacien.net) is an example of website generated using FoldaWeb.
29
30Its sources are available on GitHub at [Pacien/FoldaWeb-example](https://github.com/Pacien/FoldaWeb-example)
31
32___
33
34### Usage
35
36Simply put the binary inside a directory containing a `source` folder with the website's sources inside and run the program (simply open the executable). Another folder named `out` containing the generated website will be created instantly.
37
38You can also pass custom settings via command line arguments:
39
40 -sourceDir="./source": Path to the source directory.
41 -outputDir="./out": Path to the output directory.
42 -parsableExts="html, txt, md": Parsable file extensions separated by commas.
43 -saveAs="index.html": Save compiled files as named.
44 -startWith="index": Name without extension of the first file that will by parsed.
45 -wordSeparator="-": Word separator used to replace spaces in URLs.