diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 29 |
1 files changed, 24 insertions, 5 deletions
@@ -3,7 +3,12 @@ argent *a super-simple static site generator* -Argent is a static site generator written in C and using Lua 5.1 for scripting. I wrote it because many other static site generators I experimented with were either very rigid and complex or had been written for old versions of their chosen language and no longer worked in the modern version. Argent brings its own Lua interpreter and is written in C99, and so it should run just about anywhere that you can compile POSIX programs. +Argent is a static site generator written in C and using Lua 5.1 for scripting. +I wrote it because many other static site generators I experimented with were +either very rigid and complex or had been written for old versions of their +chosen language and no longer worked in the modern version. Argent brings its +own Lua interpreter and is written in C99, and so it should run just about +anywhere that you can compile POSIX programs. installation -------------------------------- @@ -22,7 +27,11 @@ Move the resulting `argent` binary to somewhere on your PATH (probably `~/bin`). using argent -------------------------------- -You need to provide Argent with a configuration file. By default this file is `config.lua` in the current working directory; you can override that with the `-c [config_file]` command-line option. The configuration file should be a Lua script that returns a table. The keys for this table are listed below. None of these are mandatory, and if they are omitted their default values will be used. +You need to provide Argent with a configuration file. By default this file is +`config.lua` in the current working directory; you can override that with the +`-c [config_file]` command-line option. The configuration file should be a Lua +script that returns a table. The keys for this table are listed below. None of +these are mandatory, and if they are omitted their default values will be used. | Key | Type | Default | Meaning | |------------------|--------|---------|-----------------------------------------------------------------------------------------------| @@ -42,7 +51,12 @@ You need to provide Argent with a configuration file. By default this file is `c ### site directory -This is the directory that will be compiled into the public site. All of the files within it are copied verbatim to the output directory, with the exception of `.lua` files, which should return tables with at least a markup key. They can also contain any other arbitrary keys, which will be passed on the the layout function. Certain non-markup keys are always present, and have a default value which can be overridden by the page table. +This is the directory that will be compiled into the public site. All of the +files within it are copied verbatim to the output directory, with the +exception of `.lua` files, which should return tables with at least a markup +key. They can also contain any other arbitrary keys, which will be passed on +the layout function. Certain non-markup keys are always present, and have a +default value which can be overridden by the page table. | Key | Type | Meaning | |----------|--------|-------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -55,11 +69,16 @@ This is the directory that will be compiled into the public site. All of the fil ### layouts -A layout is simply a `.lua` file that returns a function, taking as input `(string, table)`, where the string is the target page's HTML, and the table contains any non-markup keys from the target page's table. This table is guaranteed to contain a `title` and `date` key. +A layout is simply a `.lua` file that returns a function, taking as input +`(string, table)`, where the string is the target page's HTML, and the table +contains any non-markup keys from the target page's table. This table is +guaranteed to contain a `title` and `date` key. ### rss -If the `rss_include` key in the configuration table is non-nil, then an `rss.xml` file will be generated in the output root, containing all of the pages specified by `rss_include` and sorted by date. +If the `rss_include` key in the configuration table is non-nil, then an +`rss.xml` file will be generated in the output root, containing all of the +pages specified by `rss_include` and sorted by date. license |