ferron

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

commit cac116513ebdb97c2942490cf469972e06a199eb
parent 14259382eb827a3f1b6c55cdf3be6ba593d5d23f
Author: Hugo Soucy <hugo@soucy.cc>
Date:   Mon, 20 Nov 2017 21:46:38 -0500

Continue the documentation.

Diffstat:
Msites/ferron-ssg.tld/content/index.md | 83+++++++++++++++++++++----------------------------------------------------------
1 file changed, 22 insertions(+), 61 deletions(-)

diff --git a/sites/ferron-ssg.tld/content/index.md b/sites/ferron-ssg.tld/content/index.md @@ -7,24 +7,38 @@ with [Lua >= 5.3](https://www.lua.org/). ## Installation -1. `git clone git@github.com:hs0ucy/ferron-ssg.git && cd ferron-ssg` -2. Install all the dependencies above. +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 to do that + it's via [LuaRocks](https://luarocks.org/). ### Dependencies -* dkjson -* lua-path -* luafilesysem -* lustache -* markdown +* [dkjson](https://luarocks.org/modules/dhkolf/dkjson) +* [lua-path](https://luarocks.org/modules/moteus/lua-path) +* [LuaFileSysem](https://luarocks.org/modules/hisham/luafilesystem) +* [lustache](https://luarocks.org/modules/olivine-labs/lustache) +* [Markdown](https://luarocks.org/modules/mpeterv/markdown) ## Architecture of `ferron-ssg` directory * `config.lua` -* `ferron-1.0-alpha.rockspec` * `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 * **`sites`** * **`ferron-ssg.tld`** * **`archetypes`** @@ -86,56 +100,3 @@ Ferron converts mustache templates to pandoc HTML templates. A lot of params in `config/site.cfg` are includes by mustache during the creation of the [pandoc's templates](https://github.com/jgm/pandoc-templates). - -* ./templates - * mustache/ - * partials/ - * head.mustache - * feed/ - * feed-entry.mustache - * feed.mustache - * default-index.inc.mustache - * default-index.mustache - * default.mustache - * index.mustache - * pandoc - * _empty: dynamically created_ - -<!-- ## Architecture of Fakestache SSG --> - -<!-- * `archetypes/` --> -<!-- * `note.md` --> -<!-- * `config/` --> -<!-- * `config` --> -<!-- * `content/` --> -<!-- * `index.md` --> -<!-- * `functions/` --> -<!-- * `build-pandoc-templates` --> -<!-- * `clean-content-folder` --> -<!-- * `create-feed` --> -<!-- * `create-html-pages` --> -<!-- * `create-html-sections` --> -<!-- * `get-archetypes` --> -<!-- * `get-pandoc-templates` --> -<!-- * `get-static-files` --> -<!-- * `move-html-to-publichtml` --> -<!-- * `parse_yaml` --> -<!-- * `lib/` --> -<!-- * `mo/` --> -<!-- * `public_html/` --> -<!-- * `static/` --> -<!-- * `templates` --> -<!-- * `mustache/` --> -<!-- * `partials/` --> -<!-- * `head.mustache` --> -<!-- * `feed/` --> -<!-- * `feed-entry.mustache` --> -<!-- * `feed.mustache` --> -<!-- * `default-index.inc.mustache` --> -<!-- * `default-index.mustache` --> -<!-- * `default.mustache` --> -<!-- * `index.mustache` --> -<!-- * `pandoc/` --> -<!-- * `.gitignore` --> -<!-- * `.gitmodules` --> -<!-- * `fakestache` -->