55 lines
1.9 KiB
Markdown
55 lines
1.9 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 via the web frontend (no need to remote to your server to make a post)
|
|
* multi user
|
|
* powerful customisation
|
|
* rss
|
|
* timeline, user page, post page and tag specific page
|
|
* edit/delete posts
|
|
* hitcount
|
|
* Markdown syntax in posts
|
|
* Commenting on posts
|
|
* sign up and delete account
|
|
* ejs
|
|
* custom CSS _file_
|
|
|
|
# Bugs
|
|
* probably scales like shit
|
|
* probably insecure as hell
|
|
|
|
# Planned features/todo list
|
|
* edit user (could be on instead of the delete_account page)
|
|
* user specific RSS feeds
|
|
* atom
|
|
* federation (looks tricky)
|
|
* All strings (including in edit and post page) customisable
|
|
* formatable custom strings
|
|
* inline comments and docs
|
|
* clean up code a bit
|
|
* comment pages?
|
|
|
|
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
|