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

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