satelito

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

commit cf18c84a8e093a06054b290f771b3a3c21d347e5
parent d909a493f7d957bd9beb055e446d02dc211e7929
Author: Hugo Soucy <hugo@soucy.cc>
Date:   Sat, 19 Mar 2022 15:51:07 -0400

Add some stuff and fix others

Diffstat:
MREADME.md | 25+++++++++++++------------
1 file changed, 13 insertions(+), 12 deletions(-)

diff --git a/README.md b/README.md @@ -16,17 +16,18 @@ For templates, Satelito uses the [etlua templating language](https://github.com/leafo/etlua). 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. +So, through the use of Satelito you become familiar with [a +lightweight programming language](https://www.lua.org/about.html), who +has fast execution, and [short learning +curve](https://learnxinyminutes.com/docs/lua/). ## Features -* Make a static website from markdown (or HTML) files. +* Obviously ... Make a static website from markdown (or HTML) files. * Satelito can also generate pages individually or by directory. * Automatically create lists of subpages, for all index pages. -* Define page - [collections](https://codeberg.org/hs0ucy/Satelito/wiki/Collection) +* Define [page + collection](https://codeberg.org/hs0ucy/Satelito/wiki/Collection) from directory name or page name. * Automatically creates Atom/RSS syndication files, for all index pages. @@ -64,7 +65,7 @@ you `$HOME` directory. You should rename `~/satelito-sample` and edit `~/sample/config.lua` according to your needs. -Then in the folder's project where is the `config.lua` file type: +Then in the folder's project where is the `config.lua` file, type: satelito make --export @@ -152,7 +153,7 @@ the basename of the file, then the current datetime. The easiest way to build your website is with the `make` command. Go to the main folder, the one with your `config.lua`, and then: - `satelito make --export`. + satelito make --export. The `--export` option is to write the files in the `public_html/` folder, otherwise it will only display all the HTML files in the @@ -161,16 +162,16 @@ terminal (it's the same behaviour for the `pipe` command). Search recursively for all the markdown (or HTML) files with `find`, and piped directly as input to `satelito` with the `pipe` command: - `find ~/satelito-sample/content | satelito pipe`. + find ~/satelito-sample/content | satelito pipe. Same thing but with `ag`: - `ag '' --markdown --html -l ~/satelito-sample/content | satelito pipe` + ag '' --markdown --html -l ~/satelito-sample/content | satelito pipe Search for all the markdown (or HTML) files of the first level with `find`: - `find ~/satelito-sample/content -maxdepth 1 | satelito pipe`. + find ~/satelito-sample/content -maxdepth 1 | satelito pipe. Watch change with `entr` to rebuild the project: - `find ~/satelito-sample/ | entr -s 'find ~/satelito-sample/content | satelito pipe --export && echo "~/satelito-sample rebuilded at $(date +%T)"'` + find ~/satelito-sample/ | entr -s 'find ~/satelito-sample/content | satelito pipe --export && echo "~/satelito-sample rebuilded at $(date +%T)"'