diff options
| author | sanine <sanine.not@pm.me> | 2022-01-21 10:32:45 -0600 |
|---|---|---|
| committer | sanine <sanine.not@pm.me> | 2022-01-21 10:32:45 -0600 |
| commit | 5ddbdbc453f536b11415030f9c7312bb99be2527 (patch) | |
| tree | 559a0ad80e23f230f25b3cbffe96c56427adf50b /README.md | |
| parent | 0f4ebe27d2820c32ed7df74d4be8912bd73a53ac (diff) | |
update README.md config keys table
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 28 |
1 files changed, 17 insertions, 11 deletions
@@ -22,17 +22,23 @@ 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 `argent.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 containing the following: - -| Key | Type | Meaning | -|------------------|--------|--------------------------------------------------------------------------------------------------------------------------------------------------------| -| site_directory | string | filename of the directory where the site files are located | -| layout_directory | string | filename of the directory where layouts are located | -| exclude | table | array of files and directories in the `site_directory` to exclude from the public site | -| include | table | array of files and directories in the `site_directory` to forcibly include (e.g. `.htaccess` files, since dotfiles are normally excluded) | -| keep | table | array of files and directories in the public result to not touch during site generation. | -| noprocess | table | array of files and directories in the `site_directory` to exclude from processing (e.g. lua files specified here will **not** be converted into HTML). | -| rss_include | table | array of files and directories to include in the site's `rss.xml` file. | +You need to provide Argent with a configuration file. By default this file is `argent.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 | +|------------------|--------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| site_name | string | (nil) | the name of the site (used for RSS feeds, and may be used by layouts) | +| site_address | string | (nil) | the web address of the site root. required for RSS. | +| site_description | string | (nil) | a description of the site, used for RSS | +| site_copyright | string | (nil) | copyright message for RSS. | +| site_directory | string | site | name of the directory where the site files are located | +| output_directory | string | public | name of the directory to store the output in | +| layout_directory | string | (nil) | filename of the directory where layouts are located | +| plugin_directory | string | (nil) | directory to add to `package.path` | +| exclude | table | (nil) | array of patterns. if a file in `site_directory` matches one of the patterns, it will be excluded from the output. | +| include | table | (nil) | array of patterns. if a file in `site_directory` matches one of the patterns, it will be included, even if it matches an exclusion pattern. (This is useful for things like `.htaccess` files, since dotfiles are normally excluded) | +| keep | table | (nil) | array of files and directories in the public result to not touch during site generation. | +| noprocess | table | (nil) | array of patterns. if a file in `site_directory` matches one of the patterns, it will not be processed but instead copied into the output. (This is useful for .lua files you would like to include in the output.) | +| rss_include | table | (nil) | array of patterns. if set, the site will create an RSS feed and include matching files in it. | ### site directory |