From 2dfed4066500e7ebb63b2861a2adbac3238a0997 Mon Sep 17 00:00:00 2001 From: DeaDvey Date: Sun, 20 Jul 2025 23:05:53 +0100 Subject: [PATCH] CONFIG.md --- CONFIG.md | 76 ++++++++++++++++++++++++++++++++----------------------- README.md | 3 +++ 2 files changed, 48 insertions(+), 31 deletions(-) diff --git a/CONFIG.md b/CONFIG.md index d9eb315..59d0c38 100755 --- a/CONFIG.md +++ b/CONFIG.md @@ -1,27 +1,41 @@ -export const seperator = "
" -export const site_name = "My Blog" -export const site_url = "https://example.com" -export const port = 8080 -export const allow_signup = true -export const site_description = "Read my blogs!" -export const timeline_length = 20 -export const enable_hitcount = true // Can slow down page loading a bit -export const charset = "UTF-8" // Don't change unless you know why +# Configuration Documentation +## Introduction +The configuration file is stored in a file called config.json, for an example, copy example-config.json to config.json (`cp example-config.json config.json`) and modify from there.
+Currently all values in example-config.json are required, however I plan to add support for default values in the case of no value being set. + +## Technical configuration +* "site_url": "https://example.com"
+ This value defines the url of your site, this used for the RSS feed to link back to post. +* "port": 8080
+ This value defines the port that you run the blog on. Don't change this value if you don't know what that means. +* "allow_signup": true
+ Boolean that defines weather new people should be allowed to signup. +* "timeline_length": 20
+ How many posts will be shown on the timeline (home page). +* "enable_hitcount": true
+ Enabling the hitcount (a number that represents the amount of front page loads (stored in hitcount.txt)) can slightly slow down loading of the front page. +* "charset": "UTF-8"
+ This is the value in the tag in the html of all pages, you should not change this unless you know why. + +## Basic Customisation +seperator = "
" +site_name = "My Blog" +site_description = "Read my blogs!" // Anything in this directory will be in the webroot, so put favicon.ico and anything else here. -export const root_path = "/path/to/root/of/website" +root_path = "/path/to/root/of/website" // Default username if no username is inputted in comment submission -export const default_username = "Anon" +default_username = "Anon" // RSS feeds -export const rss = true -export const rss_path = "/rss" +rss = true +rss_path = "/rss" // Dates // https://date-fns.org/v4.1.0/docs/format -export const date_format = "yyyy-MM-dd" -export const time_zone = "+0000" +date_format = "yyyy-MM-dd" +time_zone = "+0000" //// Format ///// // The syntax for this is pretty simple @@ -50,7 +64,7 @@ export const time_zone = "+0000" // %Y - Site Name as defined by site_name // %Z - Attribution (to me) and source code link and license -export const timeline_header = `

%Y

+timeline_header = `

%Y

%W

Create Post
RSS Feed
@@ -58,19 +72,19 @@ export const timeline_header = `

%Y

Delete Account
Hit count: %H %S` -export const user_page_header = `

%F's posts:

+user_page_header = `

%F's posts:

%I %S` -export const tag_page_header = `

Posts tagged: %G

%S` +tag_page_header = `

Posts tagged: %G

%S` // --------------------------------------------- -export const user_post_format = `

%T

+user_post_format = `

%T

%C

%B
Permalink
%X %M %S` -export const post_page_format = `

%T

+post_page_format = `

%T

%C

%B
By %N
@@ -81,36 +95,36 @@ export const post_page_format = `

%T

%X %M %S` -export const timeline_post_format = `

%T

+timeline_post_format = `

%T

%C

Permalink
By %N %X %M %S` -export const tag_post_format = `

%T

+tag_post_format = `

%T

%C

%B
Permalink
By %N %S` // ------------------------------------- -export const site_wide_footer = `Site is ran by DeaDvey
+site_wide_footer = `Site is ran by DeaDvey
%Z` // Custom Strings -export const signup_agreement = "I agree to not post illegal or hateful content" -export const signups_unavailable = "Sorry, this server does not allow signups" -export const user_exists = "Sorry, this user already exists, try a different username" -export const user_doesnt_exist = "Sorry, this user does not exist" -export const delete_account_confirmation = "I agree that my account and all of my posts will be permanently deleted instantly" -export const incorrect_password = "Incorrect Password" +signup_agreement = "I agree to not post illegal or hateful content" +signups_unavailable = "Sorry, this server does not allow signups" +user_exists = "Sorry, this user already exists, try a different username" +user_doesnt_exist = "Sorry, this user does not exist" +delete_account_confirmation = "I agree that my account and all of my posts will be permanently deleted instantly" +incorrect_password = "Incorrect Password" /// Custom CSS to be applied to every page -export const css = ` +css = ` /* Put you custom CSS here, Read about existing classes and ID's in the docs (coming soon)*\ ` // pretty please don't change this -export const attribution = "Powered by blogger-nodejs: Source Code, license (WTFPL)" +attribution = "Powered by blogger-nodejs: Source Code, license (WTFPL)" diff --git a/README.md b/README.md index 1bc5170..17f137b 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,9 @@ This is a blogging site written in nodejs, all pages are served directly by the Please don't use this yet, it's not finished
In action on my website: [deadvey.com](https://deadvey.com)
+# Confiuration +Read the (configuation guide)[CONFIG.md] for configuration help (in config.json) + # features * post creation via the web frontend (no need to remote to your server to make a post) * multi user