szymon/static-site-generator
1
0
Fork 0
mirror of https://github.com/szymon-jozef/static-site-generator.git synced 2026-09-07 20:20:41 +02:00
Code Issues Packages Projects Releases Wiki Activity

readme update

Browse Source
This commit is contained in:
Szymon P
2026-01-07 12:06:24 +01:00
parent 0e0bc02441
commit df9874b3e2
1 changed files with 15 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@@ -12,7 +12,7 @@ As this is still a WIP, here is a short list of what works and what still needs
- [ ] generating html documents - [ ] generating html documents
- [ ] some nicer css styles - [ ] some nicer css styles
- [ ] more sensible templates - [ ] more sensible templates
- [ ] change yaml style metadata to toml? - [x] change yaml style metadata to toml
# What is this? # What is this?
This is a small blog app. Basically a static site generator. This is a small blog app. Basically a static site generator.
@@ -33,10 +33,11 @@ Every blog post needs to be in a different file in `/posts` directory.
An example from `/examples/post.md` An example from `/examples/post.md`
```md ```md
--- ---
author: "joseph" [metadata]
date: "2026-01-01" author = "joseph"
title: "Example of a blog post" date = 2026-01-01
tags: ["blog", "test", "lalilulelo"] title = "Example of a blog post"
tags = ["blog", "test", "lalilulelo"]
--- ---
# This is an example post # This is an example post
@@ -116,20 +117,22 @@ signal = "signal url"
# Metadata explanation # Metadata explanation
Metadata is everything at the beginning of the markdown file between `---`. Metadata is everything at the beginning of the markdown file between `---`.
It's written in a format similar to yaml. It's also written in toml. Why toml? I already use it's parser so it's easy to implement.
Besides it's readable and easy to write.
## Fields ## Fields
- author – the author of particular blog entry | string - author – the author of particular blog entry | string
- date – date of writing an entry | string YYYY-MM-DD - date – date of writing an entry | date
- title – title of blog entry | string - title – title of blog entry | string
- tags – tags for blog entry. | json like list - tags – tags for blog entry. | array
## Example ## Example
``` ```
author: "joseph" [metadata]
date: "2026-01-01" author = "joseph"
title: "Example of a blog post" date = 2026-01-01
tags: ["blog", "test", "lalilulelo"] title = "Example of a blog post"
tags = ["blog", "test", "lalilulelo"]
``` ```
# Why did you do this? # Why did you do this?