Welcome to the Blog

This blog was built as a response to the lack of blogging systems that accept "human readable" formats editable in a terminal emulator.

Prerequisites:

NPM
Docker (optional)

That's about it.

Formatting

Standard Markdown is supported. HTML with some basic CSS too! External CSS files aren't supported. JavaScript files aren't supported either (and won't be in the future, as it's a safety risk).

This is Markdown!

Option	Description
data	Path to data files to supply the data that will be passed into templates.
engine	Engine to be used for processing templates. Handlebars is the default.
ext	Extension to be used for destination files.

If you noticed data was blue! This works due to the HTML / CSS / Markdown Transpiler. This basically means you can embed HTML into your Markdown blog-styled posts, and it will interpret correctly!

HTML Example:

Hello from HTML

Heres the fancy source code for the interrested:

<p style="text-align:center;font-style:italic;font-weight:bold;font-size:2em;background-color:grey;font-family:cursive;color:white;">Hello from HTML</p>

Some Technical Information

For development, I used:

Docker
TypeScript
Next.js
Git (of course)

Building

If you are deploying this on your machine for whatever reason, please note:

Docker building is fully implemented and supported.
- Docker will deploy this app to port 8080 (http://localhost:8080)
If you run this with:

npm install && npm run dev # or production (if you're fancy enough to deal with it)

Note that the build times will take a while. Docker takes ages too, but once built it can recover stuff from the cache, so it's much faster after the first build.

Administration

Please set your name (or not) in @.env.local! Before deploying this to Docker!

If you are an admin, then the default username and password are:

user: admin
password: admin

Caution

Change the administration password once the server is set up. This is really easy! The server will store your password as a hash. So be careful of people getting that hash.

You can pin a post both in the UI and in the backend of the server.

/path/to/your/instance/posts/pinned.json

TODO

Status	Task
DONE	Code Editor in Admin Panel with saving!
SEMI	Exporting Tar of 'Posts/' Folder

Exporting of Folder:

This for now atleast , only works with Next.JS Production Server npm install && npm run build && npm start for reference. Docker Support for now is limited. I've gotten Persistence working. ( On Branch PM2 )

Issues

If any issues pop up, please open a Gitea issue with proper error reports!

Closing Statements

Developing of this Applet has been really fun! Thanks JavaScript for fucking my ass harder than , eh ... idk , im gay, i cant make jokes about this. Yeah fuck JavaScript, TypeScript is better.

- Thanks Rattatwinko ; 17.05.2025

4.2 KiB Raw Blame History