From 5f07db1e15cfd769aa653bcfc7f4b08102cdafdd Mon Sep 17 00:00:00 2001 From: DeaDvey Date: Sat, 9 Aug 2025 21:10:23 +0100 Subject: [PATCH] tables in CONFIG.md --- docs/CONFIG.md | 33 +++++++++++++++------------------ 1 file changed, 15 insertions(+), 18 deletions(-) diff --git a/docs/CONFIG.md b/docs/CONFIG.md index e69835c..af7ffb7 100755 --- a/docs/CONFIG.md +++ b/docs/CONFIG.md @@ -16,29 +16,26 @@ All options show an example configuartion value and the variable type + an expla | root_path | "/path/to/root/of/website" | String | Anything in this directory will be in the webroot, so put favicon.ico and anything else here. | ## Basic Customisation -* "locale": en
- String. Your locale, see [/locales](/locales) for a list of all locales (you can open a PR for a new translation too) -* "seperator": "\
"
- String. This is what %S represents in the formatting, this will go inbetween posts and generally to seperate out content on pages. -* "site_name": "My Blog"
- String. This is what %Y represents; it's the name of your instance, a human readable string. -* "site_description": "Read my blogs!" - String. This is what %W represents; it's the description of your instance, a human readable string. -* "default_commenter_username": "Anon" - String. Default commenter username if no username is inputted in comment submission. +| name | example value | variable type | explanation | +|-----------------|----------------------------|---------------|------------------------------------------------------------------------------------------------------------------------------------------------------------| +|locale|"en"|String|Your locale, see [/locales](/locales) for a list of all locales (you can open a PR for a new translation too)| +|seperator|"\
"|String|This is what %S represents in the formatting, this will go inbetween posts and generally to seperate out content on pages.| +|site_name|"My Blog"|String|This is what %Y represents; it's the name of your instance, a human readable string.| +|site_description|"Read my blogs!"|String|This is what %W represents; it's the description of your instance, a human readable string.| +|default_commenter_username|"Anon"|String|Default commenter username if no username is inputted in comment submission.| ## Syndication -* "rss": true
- Boolean. Enable or Disable RSS feeds. -* "atom": true
- Boolean. Enable or Disable ATOM feeds. +| name | example value | variable type | explanation | +|------|---------------|---------------|-------------------------------| +| rss | true | Boolean | Enable or Disable RSS feeds. | +| atom | true | Boolean | Enable or Disable ATOM feeds. | ## Dates Read more at [date-fns](https://date-fns.org/v4.1.0/docs/format)
-* "date_format": "yyyy-MM-dd"
- String. The format of date's on the website. -* "time_zone": "+0000"
- String. Your offset from UTC +| name | example value | variable type | explanation | +|------|---------------|---------------|-------------------------------| +|date_format|"yyyy-MM-dd"|String|The format of date's on the website.| +|time_zone|"+0000"|String|\Your offset from UTC| ## Advanced Customisation * /views/* files are EJS files (used for formatting HTML) and can be editted to your liking, you might want to read [the EJS docs](https://ejs.co/#docs) for help.