mirror of
https://github.com/saicaca/fuwari.git
synced 2026-01-10 14:22:51 +01:00
docs: update Korean README to match the main README (#552)
Some checks failed
Code quality / quality (push) Failing after 9s
Build and Check / Astro Check for Node.js 22 (push) Failing after 4s
Build and Check / Astro Check for Node.js 23 (push) Failing after 4s
Build and Check / Astro Build for Node.js 22 (push) Failing after 4s
Build and Check / Astro Build for Node.js 23 (push) Failing after 4s
Some checks failed
Code quality / quality (push) Failing after 9s
Build and Check / Astro Check for Node.js 22 (push) Failing after 4s
Build and Check / Astro Check for Node.js 23 (push) Failing after 4s
Build and Check / Astro Build for Node.js 22 (push) Failing after 4s
Build and Check / Astro Build for Node.js 23 (push) Failing after 4s
This commit is contained in:
@@ -13,48 +13,27 @@
|
||||
- [x] 라이트 모드 / 다크 모드
|
||||
- [x] 사용자 정의 가능한 테마 색상 및 배너
|
||||
- [x] 반응형 디자인
|
||||
- [ ] 댓글
|
||||
- [x] 검색
|
||||
- [x] [Pagefind](https://pagefind.app/)를 이용한 검색 기능
|
||||
- [x] [Markdown 확장 기능](https://github.com/saicaca/fuwari?tab=readme-ov-file#-markdown-extended-syntax)
|
||||
- [x] 목차
|
||||
- [x] RSS 피드
|
||||
|
||||
## 요구 사항
|
||||
|
||||
- Node.js <= 22
|
||||
- pnpm <= 9
|
||||
|
||||
## 🚀 사용하는 방법 1
|
||||
|
||||
[create-fuwari](https://github.com/L4Ph/create-fuwari)를 사용하여 로컬에서 프로젝트를 초기화합니다.
|
||||
|
||||
```sh
|
||||
# npm
|
||||
npm create fuwari@latest
|
||||
|
||||
# yarn
|
||||
yarn create fuwari
|
||||
|
||||
# pnpm
|
||||
pnpm create fuwari@latest
|
||||
|
||||
# bun
|
||||
bun create fuwari@latest
|
||||
|
||||
# deno
|
||||
deno run -A npm:create-fuwari@latest
|
||||
```
|
||||
|
||||
1. 블로그를 사용자 정의하려면 `src/config.ts` 구성 파일을 편집하세요.
|
||||
2. `pnpm new-post <filename>`을 실행하여 새 게시물을 만들고 `src/content/posts/`에서 편집하세요.
|
||||
3. [가이드](https://docs.astro.build/en/guides/deploy/)에 따라 블로그를 Vercel, Netlify, GitHub 페이지 등에 배포하세요. 배포하기 전에 `astro.config.mjs`에서 사이트 구성을 편집해야 합니다.
|
||||
|
||||
## 🚀 사용하는 방법
|
||||
|
||||
1. 이 템플릿에서 [새 저장소를 생성](https://github.com/saicaca/fuwari/generate)하거나 이 저장소를 포크하세요.
|
||||
2. 블로그를 로컬에서 편집하려면 저장소를 복제하고 `pnpm install` 및 `pnpm add sharp`를 실행하여 종속성을 설치하세요.
|
||||
- 아직 [pnpm](https://pnpm.io)을 설치하지 않았다면 `npm install -g pnpm`을 실행하여 [pnpm](https://pnpm.io)을 설치하세요.
|
||||
3. 블로그를 사용자 정의하려면 `src/config.ts` 구성 파일을 편집하세요.
|
||||
4. `pnpm new-post <filename>`을 실행하여 새 게시물을 만들고 `src/content/posts/`에서 편집하세요.
|
||||
5. [가이드](https://docs.astro.build/en/guides/deploy/)에 따라 블로그를 Vercel, Netlify, GitHub 페이지 등에 배포하세요. 배포하기 전에 `astro.config.mjs`에서 사이트 구성을 편집해야 합니다.
|
||||
## 🚀 시작하기
|
||||
1. 블로그 저장소를 생성하세요:
|
||||
- 이 템플릿에서 [새 저장소를 생성](https://github.com/saicaca/fuwari/generate)하거나 이 저장소를 포크하세요.
|
||||
- 또는 다음 명령어 중 하나를 실행하세요:
|
||||
```sh
|
||||
npm create fuwari@latest
|
||||
yarn create fuwari
|
||||
pnpm create fuwari@latest
|
||||
bun create fuwari@latest
|
||||
deno run -A npm:create-fuwari@latest
|
||||
```
|
||||
2. 로컬에서 블로그를 수정하려면, 저장소를 복제하고 `pnpm install`을 실행하여 종속성을 설치하세요.
|
||||
- [pnpm](https://pnpm.io)이 설치되어 있지 않다면 `npm install -g pnpm`을 실행하여 설치하세요.
|
||||
3. `src/config.ts`설정 파일을 수정하여 블로그를 커스터마이징하세요.
|
||||
4. `pnpm new-post <filename>`을 실행하여 새 게시물을 만들고 `src/content/posts/`에서 수정하세요.
|
||||
5. [가이드](https://docs.astro.build/en/guides/deploy/)에 따라 블로그를 Vercel, Netlify, Github Pages 등에 배포하세요. 배포하기 전에 `astro.config.mjs`에서 사이트 구성을 수정해야 합니다.
|
||||
|
||||
## ⚙️ 게시물의 머리말 설정
|
||||
|
||||
@@ -63,24 +42,41 @@ deno run -A npm:create-fuwari@latest
|
||||
title: 내 첫 블로그 게시물
|
||||
published: 2023-09-09
|
||||
description: 내 새로운 Astro 블로그의 첫 번째 게시물입니다!
|
||||
image: /images/cover.jpg
|
||||
tags: [푸, 바, 오]
|
||||
category: 앞-끝
|
||||
image: ./cover.jpg
|
||||
tags: [Foo, Bar]
|
||||
category: Front-end
|
||||
draft: false
|
||||
lang: jp # 게시물의 언어가 `config.ts`의 사이트 언어와 다른 경우에만 설정합니다.
|
||||
---
|
||||
```
|
||||
## 🧩 마크다운 확장 구문
|
||||
Astro의 기본 [GitHub Flavored Markdown](https://github.github.com/gfm/) 지원 외에도 몇 가지 추가적인 마크다운 기능이 포함되어 있습니다.
|
||||
- Admonitions ([미리보기 및 사용법](https://fuwari.vercel.app/posts/markdown-extended/#admonitions))
|
||||
- GitHub 저장소 카드 ([미리보기 및 사용법](https://fuwari.vercel.app/posts/markdown-extended/#github-repository-cards))
|
||||
- Expressive Code를 사용한 향상된 코드 블록 ([미리보기](https://fuwari.vercel.app/posts/expressive-code/) / [문서](https://expressive-code.com/))
|
||||
|
||||
## 🧞 명령어
|
||||
|
||||
|
||||
## ⚡ 명령어
|
||||
|
||||
모든 명령어는 프로젝트 최상단, 터미널에서 실행됩니다:
|
||||
|
||||
| Command | Action |
|
||||
|:------------------------------------|:-------------------------------------------------|
|
||||
| `pnpm install` AND `pnpm add sharp` | 종속성을 설치합니다. |
|
||||
| `pnpm install` | 종속성을 설치합니다. |
|
||||
| `pnpm dev` | `localhost:4321`에서 로컬 개발 서버를 시작합니다. |
|
||||
| `pnpm build` | `./dist/`에 프로덕션 사이트를 구축합니다. |
|
||||
| `pnpm check` | 코드에서 오류를 확인합니다. |
|
||||
| `pnpm format` | Biome을 사용하여 코드를 포멧합니다. |
|
||||
| `pnpm preview` | 배포하기 전에 로컬에서 빌드 미리보기 |
|
||||
| `pnpm new-post <filename>` | 새 게시물 작성 |
|
||||
| `pnpm astro ...` | `astro add`, `astro check`와 같은 CLI 명령어 실행 |
|
||||
| `pnpm astro --help` | Astro CLI를 사용하여 도움 받기 |
|
||||
|
||||
## ✏️ 기여
|
||||
이 프로젝트에 기여하는 방법에 대한 자세한 내용은 [기여 가이드](https://github.com/saicaca/fuwari/blob/main/CONTRIBUTING.md)를 확인하세요.
|
||||
|
||||
## 📄 라이선스
|
||||
이 프로젝트는 MIT 라이선스에 따라 라이선스가 부여됩니다.
|
||||
|
||||
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fsaicaca%2Ffuwari?ref=badge_large&issueType=license)
|
||||
Reference in New Issue
Block a user