From 31dd8bfd4e6e2e9e8724bfada3815d75b1eaa393 Mon Sep 17 00:00:00 2001
From: Depact
Date: Tue, 22 Sep 2026 14:51:04 +0300
Subject: [PATCH 1/2] Added instruction for creating blog posts.
---
README.md | 44 +++++++++++++++++++++++++++++++++++++++++---
1 file changed, 41 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index d1631d6..8150049 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,51 @@
-# Setup
+# Setup & Running Locally
-```
+```bash
pnpm i
pnpm dev
```
For production preview:
-```
+```bash
pnpm build
npx serve .output/public
```
+# Adding Blog Posts
+
+1. Create folder in `public\blog\posts` and .md file with same name as folder you created here.
+File name doubles as blog post ID and url.
+Example:
+ ```
+ public\blog\posts\weekly-update-230\weekly-update-230.md
+ ```
+
+ - Blog post file have to start with markdown front matter with title, date and description.
+ - Title and description is strictly text.
+
+2. In blog post .md ensure front matter created
+**Front Matter example:**
+```md
+---
+title: "Weekly Dev Update #221"
+date: "2025-12-14T00:00:00.000Z"
+description: "Hiyo slime gang~! Spazzwan here, but mostly in a metaphorical sense. It's more like t..."
+---
+```
+
+For blog posts images and emoji relative repo path and blog post paths are supported
+**Example of emoji use in blog post with relative repo path:**
+```md
+
+```
+
+**Example of image use in blog post with relative blog post path:**
+```md
+
+```
+
+3. Once you finished preparing blog post, run build to generate pagination API records.
+```bash
+pnpm build
+```
+Include in your PR with blog post generated materialized API responses.
From d291bdc9caeebbe14b0bb6cd9e60b9397d0f16e8 Mon Sep 17 00:00:00 2001
From: Depact
Date: Tue, 22 Sep 2026 15:03:29 +0300
Subject: [PATCH 2/2] Rewrite for readabililty and joined lines fix
---
README.md | 38 +++++++++++++++++++++++---------------
1 file changed, 23 insertions(+), 15 deletions(-)
diff --git a/README.md b/README.md
index 8150049..a1ae76e 100644
--- a/README.md
+++ b/README.md
@@ -13,18 +13,19 @@ npx serve .output/public
# Adding Blog Posts
-1. Create folder in `public\blog\posts` and .md file with same name as folder you created here.
-File name doubles as blog post ID and url.
-Example:
+1. Create folder in `public\blog\posts` and `.md` file within it with same.
+File name doubles as blog post ID and url on site.
+Path example:
```
public\blog\posts\weekly-update-230\weekly-update-230.md
```
+
+1. In blog post `.md` file ensure front matter created
- Blog post file have to start with markdown front matter with title, date and description.
- Title and description is strictly text.
-2. In blog post .md ensure front matter created
-**Front Matter example:**
+ Front Matter example:
```md
---
title: "Weekly Dev Update #221"
@@ -33,19 +34,26 @@ description: "Hiyo slime gang~! Spazzwan here, but mostly in a metaphorical sens
---
```
-For blog posts images and emoji relative repo path and blog post paths are supported
-**Example of emoji use in blog post with relative repo path:**
+1. Once you finished preparing blog post, run build to generate pagination API records.
+```bash
+pnpm build
+```
+Include in your PR with blog post generated materialized API responses.
+
+### Linking Images In Blog posts
+
+For blog posts images and emoji linking two path options supported:
+
+- Relative repository path
+
+ Example of emoji use in blog post with relative repo path:
```md
```
-**Example of image use in blog post with relative blog post path:**
+- Relative blog post path
+
+ Example of image linking in blog post with relative blog post path:
```md

-```
-
-3. Once you finished preparing blog post, run build to generate pagination API records.
-```bash
-pnpm build
-```
-Include in your PR with blog post generated materialized API responses.
+```
\ No newline at end of file