Documentation

This commit is contained in:
2025-08-09 20:53:57 +01:00
parent f85c4aa893
commit 0b25fb221b
3 changed files with 22 additions and 30 deletions

View File

@@ -21,6 +21,8 @@ All options show an example configuartion value and the variable type + an expla
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/>
@@ -50,27 +52,4 @@ Read more at [date-fns](https://date-fns.org/v4.1.0/docs/format)<br/>
You can also edit the custom.css file in the webroot, as by default this is linked in the global header.
## Custom Strings
All of these values are of type String and are in the "string" object.
* "signup_agreement": "I agree to not post illegal or hateful content"<br/>
The agreement people must check to signup for the server.
* "signups_unavailable": "Sorry, this server does not allow signups"<br/>
The string to be displayed if the user tries to signup when signup's are disabled.
* "user_exists": "Sorry, this user already exists, try a different username"<br/>
The string to be shown when someone is trying to signup with a name exists.
* "user_doesnt_exist": "Sorry, this user does not exist"<br/>
The string to be shown when someone tries to edit their account or make a post but the username doesn't exist.
* "comment_doesnt_exist": "This comment doesn't exist, this could be because the post it was attached to was deleted"<br/>
String to be shown if someone goes to /comment/commentID but that comment doesnt exist (sometimes because the post it was attatched to was deleted)
* "post_doesnt_exist": "This post doesn't exist or was deleted"<br/>
Shown when someone goes to /post/postID but that post was deleted or doesn't exist.
* "delete_account_confirmation": "I agree that my account and all of my posts will be permanently deleted instantly"<br/>
The string to be shown as a confirmation when a user tries to delete their account.
* "incorrect_password": "Incorrect Password"<br/>
The string to be shown if the password is incorrect.
* "rss_disabled": "Sorry,·RSS·is·disabled"<br/>
String to be shown if an RSS file is loaded but RSS is disabled
* "atom_disabled": "Sorry, ATOM is disabled"<br/>
Same as above but ATOM
* "attribution" = "Powered by blogger-nodejs: <a href='https://git.javalsai.tuxcord.net/deadvey/blogger-nodejs'>Source Code</a>, <a href='https://git.javalsai.tuxcord.net/deadvey/blogger-nodejs/raw/branch/master/LICENSE'>license (WTFPL)</a>"
Represented by format indicator %Z. Only change this value if you modify the source code or just want to change some of the formatting.
* You can edit all the strings on the site in /locales/<your-locale>.json