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

docs and that

Browse Source
This commit is contained in:
DeaDvey
2025-08-02 02:48:22 +01:00
parent 8b9ddcf048
commit f723e37732
4 changed files with 38 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@@ -40,13 +40,9 @@ Read the [configuation guide](docs/CONFIG.md) for configuration help (in config.
* Make EJS modification more user friendly
* API for returning posts, users, comments, tags other?...
TODO (not finished)
# EJS variable names
* config.variable_name - pass any variable in config.json
* hitcount - value in hitcount.txt (a single number)
## Posts (/views/posts/)
* post - an object that includes the data for that post, eg post.title, post.content etc
* user - the object of the user who posted this
* index - an int that refers to the index of the current post
## Comments (/views/partials/comment.ejs)
* comment - an object storing the comment, eg comment.name, comment.content
# Docs
See [docs/DOCUMENTATION.md](docs/DOCUMENTATION.md)
# Customisation
Customisation of settings can be done via the config.json file (use example-config.json as an example) and see [the configuration guide](docs/CONFIG.md)<br/>
Additionaly, more complex configuration of the precise template of the whole site, can be done via [EJS](https://ejs.co/) (in /views) (see [the list of things variables and functions available in EJS](docs/EJS.md) (you will need to understand EJS syntax and JavaScript, to customise this (why did I use EJS? well I originally had this weird system of format indicators with percent (%) signs and stuff (like in unix's date (`date`)) but then I was told EJS is better and it sure is, though it is a bit harder to understand but MUCH more powerful!))