summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorsanine <sanine.not@pm.me>2022-01-21 10:51:45 -0600
committersanine <sanine.not@pm.me>2022-01-21 10:51:45 -0600
commit480197b1c20bd22731c89df2b087e82d7b2f699d (patch)
tree47475f5806d609e3d5936635d0d46eb2a1ee97d8 /README.md
parent5ddbdbc453f536b11415030f9c7312bb99be2527 (diff)
make config key descriptions more concise
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 15 insertions, 15 deletions
diff --git a/README.md b/README.md
index 0884788..26e137d 100644
--- a/README.md
+++ b/README.md
@@ -24,21 +24,21 @@ 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. 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. |
+| 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. a file that matches any pattern will be excluded from the output. |
+| include | table | (nil) | array of patterns. a file that matches will be included, even if it otherwise would not. |
+| keep | table | (nil) | array of files and directories in the public result to not touch during site generation. |
+| noprocess | table | (nil) | array of patterns. a file that matches will be output verbatim. |
+| rss_include | table | (nil) | array of patterns. if set, the site will create an RSS feed and include matching files in it. |
### site directory