deadvey/blogger-nodejs
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

tables in CONFIG.md

Browse Source
This commit is contained in:
DeaDvey
2025-08-09 21:10:23 +01:00
parent d298717519
commit 5f07db1e15
1 changed files with 15 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
docs/CONFIG.md
View File

@@ -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<br/>
String. Your locale, see [/locales](/locales) for a list of all locales (you can open a PR for a new translation too)
* "seperator": "\<hr/\>"<br/>
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"<br/>
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|"\<hr/\>"|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<br/>
Boolean. Enable or Disable RSS feeds.
* "atom": true<br/>
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)<br/>
* "date_format": "yyyy-MM-dd"<br/>
String. The format of date's on the website.
* "time_zone": "+0000"<br/>
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.