update : update readme

Author: sookim-1

README.md

@@ -1,2 +1,49 @@
-# sookim blog
-This repository contains a static website for my blog, built with Ignite. It showcases my skills and experience in a user-friendly format.
+![create_post](https://github.com/sookim-1/k-swift-ignite-blog/actions/workflows/create_post.yml/badge.svg)
+![build-and-deploy](https://github.com/sookim-1/k-swift-ignite-blog/actions/workflows/build-and-deploy.yml/badge.svg)
+
+## k-swift-ignite-blog 설명
+
+해당 저장소는 Swift 언어로 Static Website를 편리하게 작성하도록 도와주는 [Ignite](https://github.com/twostraws/Ignite)라이브러리를 사용했습니다.
+
+개인용도로 매주 개발과 관련된 내용을 회고느낌으로 작성한 블로그배포 저장소입니다.
+
+> 예시
+
+![sample_website_capture](./docs/sample_website_capture.png)
+
+- 실제 구현된 웹사이트를 확인 👉 [sookim-1 주간회고록](https://sookim-1.github.io/)
+- 자세한 개발 경험 확인 👉 [Ignite로 T.W.L 블로그 마이그레이션 및 오픈소스 기여 후기](./docs/Ignite로 T.W.L 블로그 마이그레이션 및 오픈소스 기여 후기.md)
+
+## 커스텀 방법
+
+해당 저장소를 활용하여 개인 T.W.L 블로그를 구축할 수 있습니다.
+
+1. 해당 저장소 를 fork 합니다.
+2. `Content` 폴더에 마크다운 문서를 추가합니다.
+3. `Global.swift` 에서 변수들을 알맞는 값으로 변경합니다.
+
+> 게시글 마크다운 형식 예시
+
+```markdown
+---
+author: sookim-1
+description: Ignite 마이그레이션
+date: 2025-01-01 23:00
+tags: iOS, Swift
+published: true
+---
+# 번호 : 001, 작성일자: 2025-01-01
+```
+
+## 워크플로 실행 방법
+
+### 깃허브 페이지 자동 배포 워크플로
+1. [Content](./Content) 폴더에 마크다운문서를 추가합니다.
+2. 추가한 후 main브랜치에 Merge되면 [build-and-deploy.yml](./.github/workflows/build-and-deploy.yml) 워크플로가 동작합니다.
+3. 워크플로가 통과되면 userName.github.io 원격저장소에 배포됩니다.
+
+### 문서 작성 워크플로
+1. [create_post.yml](./.github/workflows/create_post.yml) 워크플로를 동작합니다.
+2. 문서번호, 작성일자, 회고 시작일, 회고 종료일을 입력받아서 문서를 작성하여 PR이 진행됩니다.
+3. 문서내용을 수정하여 PR을 Merge하면 위의 블로그 배포방법 순서로 배포됩니다.
+

Sources/Components/SocialFooter.swift

@@ -16,9 +16,9 @@ public struct SocialFooter: Component {
     ]
 
     let urlStrings = [
-        "https://github.com/sookim-1",
-        "https://www.linkedin.com/in/sookim1",
-        "https://sookim-1.medium.com"
+        githubAddress,
+        linkedInAddress,
+        blogAddress
     ]
 
     public func body(context: PublishingContext) -> [any PageElement] {

Sources/Global.swift

@@ -0,0 +1,21 @@
+import Foundation
+
+// mailto:<your_email>@gmail.com
+let gmailAddress = "mailto:[email protected]"
+
+// https://www.linkedin.com/in/<your_linkedin>
+let linkedInAddress = "https://www.linkedin.com/in/soohwan-kim-80250623a/"
+
+let blogAddress = "https://sookim-1.tistory.com/"
+
+// <your_github_name>
+let githubProfileName = "sookim-1"
+
+// https://github.com/<your_github_name>
+let githubAddress = "https://github.com/\(githubProfileName)"
+
+// https://<your_github_name>.github.io
+let githubPagesAddress = "https://\(githubProfileName).github.io"
+
+// <your_github_name>/<your_github_name>.github.io
+let githubDeployAddress = "\(githubProfileName)/\(githubProfileName).github.io"

Sources/Site.swift

@@ -15,18 +15,18 @@ struct IgniteWebsite {
 }
 
 struct SookimSite: Site {
-    var name = "sookim-1"
+    var name = githubProfileName
     var titleSuffix = " – My T.W.L Site"
-    var url = URL(string: "https://sookim-1.github.io")!
+    var url = URL(string: githubPagesAddress)!
     var builtInIconsEnabled = true
 
-    var author = "sookim-1"
+    var author = githubProfileName
 
     var homePage = Home()
     var theme = MyTheme()
     var tagPage = Tags()
     var favicon = URL(string: "/images/favicon.png")
-    var feedConfiguration = FeedConfiguration(mode: .full, contentCount: 20, image: .init(url: "https://sookim-1.github.io/images/favicon.png", width: 32, height: 32))
+    var feedConfiguration = FeedConfiguration(mode: .full, contentCount: 20, image: .init(url: "\(githubPagesAddress)/images/favicon.png", width: 32, height: 32))
 
     var pages: [any StaticPage] {
         Home()