149 lines
4.7 KiB
Markdown
149 lines
4.7 KiB
Markdown
---
|
|
title: Read Me . Markdown!
|
|
date: '2025-06-19'
|
|
tags:
|
|
- welcome
|
|
- introduction
|
|
summary: Read Me Please
|
|
author: Rattatwinko's
|
|
---
|
|
|
|
# Welcome to the Blog
|
|
|
|
## Overview
|
|
|
|
- [Starting Things off!](#starting-things-off)
|
|
- [Formatting](#formatting)
|
|
- [Some Technical Information](#some-technical-information)
|
|
- [Building](#building)
|
|
- [Administration](#administration)
|
|
- [Todo List for the Project](#todo)
|
|
- [Issues with the Project](#issues)
|
|
- [Changelog](#changelog)
|
|
- [Closing Statements](#closing-statements)
|
|
|
|
## Starting Things off!
|
|
|
|
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 |
|
|
| ------ | ----------- |
|
|
| <span style="color:blue;">data</span> | 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. |
|
|
|
|
<p style="background-color:grey;color:white;font-style:italic;">If you noticed <span style="color: #5BCEFA; font-weight: bold;">data</span> was blue! This works due to the HTML / CSS / Markdown <span style="font-weight: bold; font-size: 1em; padding: 0.2em 0.4em; border-radius: 4px;"><span style="color: #5BCEFA;">T</span><span style="color: #F5A9B8;">r</span><span style="color: #FFFFFF;">a</span><span style="color: #F5A9B8;">n</span><span style="color: #5BCEFA;">s</span>piler</span>. This basically means you can embed HTML into your Markdown blog-styled posts, and it will interpret correctly!</p>
|
|
|
|
**HTML Example:**
|
|
|
|
<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>
|
|
|
|
Heres the fancy **source code** for the **interrested**:
|
|
|
|
```html
|
|
<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:
|
|
|
|
```sh
|
|
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
|
|
|
|
<p style="color:red;font-style:bolder;">Please set your name (or not) in @.env.local! Before deploying this to Docker!</p>
|
|
|
|
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.
|
|
|
|
```sh
|
|
/path/to/your/instance/posts/pinned.json
|
|
```
|
|
|
|
---
|
|
|
|
## TODO
|
|
|
|
| Status | Task |
|
|
|:---------------------------------------------:|:-------------------------------------------------:|
|
|
|<span style="color:green;text-align:center;">DONE</span>|Code Editor in Admin Panel with saving!|
|
|
|<span style="color:green;"> DONE! </span>| Exporting Tar of 'Posts/' Folder|
|
|
|<span style="color:green;"> DONE! </span>| Mobile Viewing of the Website|
|
|
|<span style="color:orange;"> TO BE DONE! | Refactoring of the Code (Removing Garbage-Code)
|
|
|
|
|
|
---
|
|
|
|
## Issues
|
|
|
|
If any issues pop up, please open a Gitea issue with **proper** error reports!
|
|
|
|
---
|
|
|
|
## Changelog:
|
|
|
|
- Via merging of branch **"mobile"**:
|
|
- Will have support for mobile devices
|
|
- Scrolling will be "different" (auto header scroll trough links)
|
|
- Styling will be responsive!
|
|
|
|
---
|
|
|
|
## 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.
|
|
|
|
<q style="font-style:italic;">
|
|
- Thanks Ratta<b>twink</b>o ; 17.05.2025
|
|
</q>
|
|
<img src="https://upload.wikimedia.org/wikipedia/commons/4/48/Gay_Pride_Flag.svg" style="width:50px;height:50px;float:left;"/>
|