Static [web] site (or page) generator (ssg) made with Lua script.
git clone git://
Log | Files | Refs | README

commit 0ceb83743102ed70deca6699df3e3ea9024db08d
parent 7e9f8e2eb4f7b580657545e87dd16616b1c9865b
Author: Hugo Soucy <>
Date:   Fri,  5 Feb 2021 09:29:44 -0500

Start to write some documentation in the README.

Diffstat: | 57+++++++++++++++++++++++++--------------------------------
1 file changed, 25 insertions(+), 32 deletions(-)

diff --git a/ b/ @@ -1,49 +1,42 @@ # Satelito -<!-- --[[ --> -<!-- *satelito* is a static site generator in lua. Even the [meta]data are in lua table. --> -<!-- - You can pipe (stdin) filepaths to it or you can pass a filepath as an argument or you can call it as a module. --> -<!-- - It's standalone, so you don't have to install anything to your computer. --> -<!-- The couple dependencies are in the `lib/` folder. --> -<!-- - But some conventions prevails --> -<!-- -- Page who's listed other pages must be named --> -<!-- -- The path of Templates folder must be in the config.lua --> -<!-- - satelito don't deal with any preprocessing static content like Sass but you can do it: --> -<!-- -- with SassC et entr in a simple shell script ... or pick your favorite libSass flavor. --> - -<!-- It's a only lua and markdown --> -<!-- * Site Metadatas => lua --> -<!-- * Page HTML --> -<!-- ** Content in markdown => HTML --> -<!-- ** Metadatas in lua only --> -<!-- ** Template with etlua --> -<!-- --]] --> - -Satelito is a static site generator (ssg) made with lua script. Even -the metadata use lua file, instead *front matter* in yaml or json -embedded inside the markdown file, often seen in other satic site -generators. - -Because Lua data table are pretty simple and allows to execute lambda -function in it. +[Beware! Satelito is under development, same for its documentation.] + +Satelito is a static site generator (ssg) made with lua script. + +Satelito uses markdown for basic content and separate (but optional) +lua files for metadata. There is no support for front matter, instead +we rely on the power and versatility of the lua tables, in which we +can write lua functions that will extend the functionality of our +static site. + +For templates, Satelito uses the [etlua templating +language]( It is simple, but powerful, +because it allows you to run lua script directly in templates. + +So, through the use of Satelito you become familiar with a lightweight +programming language, who has fast execution, and short learning +curve. ## Installation To install Satelito, you must have [Luarocks]( -installed on your computer: +and [Git]( on your computer: <>. - * Then in your terminal `luarocks install --server= satelito --local`. +Then in your terminal: + + * `luarocks install --server= satelito --local`. If the installation went successfully you can test Satelito by invoking the help page: * `satelito -h` ---- + +## Usage - `find mySiteSrc/ -name '*.md' | satelito --export` - `ag '' --markdown -l mySitesrc/ | satelito --export` -Watch changes `find` et `entr`: - -- `find mySiteSrc/ | entr -s 'echo "Modification!" && find mySiteSrc/ -name "*.md" | ./satelito/satelito --export'` +<!-- Watch changes `find` et `entr`: --> +<!-- - `find mySiteSrc/ | entr -s 'echo "Modification!" && find mySiteSrc/ -name "*.md" | satelito --export'` -->