ferron

Ferron is a fast and simple static website generator made with Lua.
Log | Files | Refs | Submodules | README | LICENSE

commit 4f8ad05d74c69ef649e34890da726f692030c054
parent b83df73d3c4da0171f6c833b73f1044dabba43cb
Author: Hugo Soucy <hugo@soucy.cc>
Date:   Mon, 20 Nov 2017 22:37:36 -0500

Continue the edition of the documentation

Diffstat:
Msites/ferron-ssg.tld/content/index.md | 54+++++++++++++++++++++++++++++++++++-------------------
1 file changed, 35 insertions(+), 19 deletions(-)

diff --git a/sites/ferron-ssg.tld/content/index.md b/sites/ferron-ssg.tld/content/index.md @@ -8,9 +8,10 @@ with [Lua >= 5.3](https://www.lua.org/). ## Installation 1. Make sure Lua 5.3 or up is installed on your machine. -2. `git clone git@github.com:hs0ucy/ferron-ssg.git && cd ferron-ssg` -3. Install all the dependencies above, and for me the best way to do - that it's via [LuaRocks](https://luarocks.org/). +2. Then `git clone git@github.com:hs0ucy/ferron-ssg.git && cd + ferron-ssg` +3. After that install all the dependencies above. For me, the best way + to do that it's via [LuaRocks](https://luarocks.org/). ### Dependencies @@ -20,7 +21,22 @@ with [Lua >= 5.3](https://www.lua.org/). * [lustache](https://luarocks.org/modules/olivine-labs/lustache) * [Markdown](https://luarocks.org/modules/mpeterv/markdown) -## Usage +## Get Started + +First you need to copy the default site and give it the name of the +website you want to create: + +``` +cd sites/ && cp -R ferron-ssg.tld mynewwebsite.net && ls +``` + +After that with your favorite texteditor or IDE edit the +`site.config.lua` to meet the needs of your web site: + +``` +emacs site.config.lua +``` + * To simply build a web site: * `lua ferron.lua` @@ -33,19 +49,19 @@ with [Lua >= 5.3](https://www.lua.org/). * `rhino` * `ferron.lua` * **`functions`** - * create-archetype-content.lua - * exec.lua - * file-utils.lua - * get-archetypes.lua - * get-sites.lua - * make-atom-feed.lua - * make-lists-of-pages.lua - * make-pages.lua - * move-to-publichtml.lua - * set-site.lua - * string-utils.lua - * table-utils.lua - * template-utils.lua + * `create-archetype-content.lua` + * `exec.lua` + * `file-utils.lua` + * `get-archetypes.lua` + * `get-sites.lua` + * `make-atom-feed.lua` + * `make-lists-of-pages.lua` + * `make-pages.lua` + * `move-to-publichtml.lua` + * `set-site.lua` + * `string-utils.lua` + * `table-utils.lua` + * `template-utils.lua` * **`sites`** * **`ferron-ssg.tld`** * **`archetypes`** @@ -59,7 +75,7 @@ with [Lua >= 5.3](https://www.lua.org/). All the content of your site should be markdown (`*.md`) file and belongs in the `content/` repository. That folder must contains at -least an `index.md` file. +least an `index.md` file and an `index.json`. ## Archetypes @@ -91,7 +107,7 @@ away whithout the need of filling the metadatas. Ferron uses the [mustache template engine](http://mustache.github.io/) -([for lua](https://github.com/tests-always-included/mo)) to give more +([for lua](https://github.com/Olivine-Labs/lustache)) to give more flexibility to build your theme. When you build your project Ferron converts mustache templates to pandoc HTML templates.