docs and that

This commit is contained in:
2025-08-02 02:48:22 +01:00
parent 8b9ddcf048
commit f723e37732
4 changed files with 38 additions and 10 deletions

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!))

1
docs/CONTRIBUTING.md Normal file
View File

@@ -0,0 +1 @@
Just open a PR or something, if it's good I'll pull

4
docs/DOCUMENTATION.md Normal file
View File

@@ -0,0 +1,4 @@
All documentation is under construction as the program is also under construction and so is constantly changing and is also a mess and I'm shit at documentation
- [EJS Variables and functions](EJS.md)
- [configuring config.json](CONFIG.md)
- [Contributing](CONTRIBUTING.md)

27
docs/EJS.md Normal file
View File

@@ -0,0 +1,27 @@
This is not a guide on how EJS works, look at [EJS's website](https://ejs.co/) for that!<br/>
This is just a list of functions and pieces of information provided to each EJS file.<br/>
<br/>
# syndication/global_rss:
- All config.json data
- All posts from posts.json
- showdown.JS's converter functions
- All functions in functions.js
# syndication/user_rss:
- All config.json data
- All posts from posts.json
- showdown.JS's converter functions
- All functions in functions.js
- the userID of the user in question (integer)
# syndication/global_atom:
- All config.json data
- All posts from posts.json
- showdown.JS's converter functions
- All functions in functions.js
- getUnixTime function from date-fns
# syndication/user_atom:
- All config.json data
- All posts from posts.json
- showdown.JS's converter functions
- All functions in functions.js
- the userID of the user in question (integer)
- getUnixTime function from date-fns