49 lines
2.2 KiB
Markdown
49 lines
2.2 KiB
Markdown
This software aims to provide a lot of power to the web admin who is running the blog site.<br/>
|
|
Customisation is unlimited with a bit of knowledge of EJS and CSS, you can edit the entire formatting of the pages, making the site truly yours!<br/>
|
|
This software also aims to be compatible with text based browsers and as a result contains no client side Javascript, if you're looking for a more<br/>
|
|
beautiful and featureful blogging frontend, this isn't for you.<br/>
|
|
|
|
> [!CAUTION]
|
|
> This software is not finished yet, so it's very buggy and probably really insecure<br/>
|
|
> use at your own risk!<br/>
|
|
|
|
See the software in action: [deadvey.com](https://deadvey.com)<br/>
|
|
|
|
|
|
# Confiuration
|
|
Read the [configuation guide](docs/CONFIG.md) for configuration help (in config.json)
|
|
|
|
# Features
|
|
* post creation, modification and deletion via frontend
|
|
* user creation, modification and deletion via frontend
|
|
* multi user
|
|
* powerful customisation via EJS
|
|
* site wide and user specific rss, atom
|
|
* hitcount
|
|
* Markdown syntax in posts
|
|
* Commenting on posts and replying to other comments
|
|
* site wide custom CSS
|
|
* Page indexes
|
|
|
|
# Bugs
|
|
* probably scales like shit
|
|
* probably insecure as hell
|
|
|
|
# Planned features/todo list
|
|
* federation (looks tricky)
|
|
* All strings (including in edit and post page) customisable
|
|
* formatable custom strings
|
|
* inline comments and docs
|
|
* clean up code a bit
|
|
* /postID and /userID pages
|
|
* site index
|
|
* Make EJS modification more user friendly
|
|
* API for returning posts, users, comments, tags other?...
|
|
|
|
# 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!))
|