|
1 | | -# 🍥Fuwari |
2 | | - |
3 | | - |
4 | | -[](https://deepwiki.com/saicaca/fuwari) |
5 | | -[](https://app.fossa.com/projects/git%2Bgithub.qkg1.top%2Fsaicaca%2Ffuwari?ref=badge_shield&issueType=license) |
6 | | - |
7 | | -A static blog template built with [Astro](https://astro.build). |
8 | | - |
9 | | -[**🖥️ Live Demo (Vercel)**](https://fuwari.vercel.app) |
10 | | - |
11 | | - |
12 | | - |
13 | | -🌏 README in |
14 | | -[**中文**](https://github.com/saicaca/fuwari/blob/main/docs/README.zh-CN.md) / |
15 | | -[**日本語**](https://github.com/saicaca/fuwari/blob/main/docs/README.ja.md) / |
16 | | -[**한국어**](https://github.com/saicaca/fuwari/blob/main/docs/README.ko.md) / |
17 | | -[**Español**](https://github.com/saicaca/fuwari/blob/main/docs/README.es.md) / |
18 | | -[**ไทย**](https://github.com/saicaca/fuwari/blob/main/docs/README.th.md) / |
19 | | -[**Tiếng Việt**](https://github.com/saicaca/fuwari/blob/main/docs/README.vi.md) / |
20 | | -[**Bahasa Indonesia**](https://github.com/saicaca/fuwari/blob/main/docs/README.id.md) (Provided by the community and may not always be up-to-date) |
21 | | - |
22 | | -## ✨ Features |
23 | | - |
24 | | -- [x] Built with [Astro](https://astro.build) and [Tailwind CSS](https://tailwindcss.com) |
25 | | -- [x] Smooth animations and page transitions |
26 | | -- [x] Light / dark mode |
27 | | -- [x] Customizable theme colors & banner |
28 | | -- [x] Responsive design |
29 | | -- [x] Search functionality with [Pagefind](https://pagefind.app/) |
30 | | -- [x] [Markdown extended features](https://github.com/saicaca/fuwari?tab=readme-ov-file#-markdown-extended-syntax) |
31 | | -- [x] Table of contents |
32 | | -- [x] RSS feed |
33 | | - |
34 | | -## 🚀 Getting Started |
35 | | - |
36 | | -1. Create your blog repository: |
37 | | - - [Generate a new repository](https://github.com/saicaca/fuwari/generate) from this template or fork this repository. |
38 | | - - Or run one of the following commands: |
39 | | - ```sh |
40 | | - npm create fuwari@latest |
41 | | - yarn create fuwari |
42 | | - pnpm create fuwari@latest |
43 | | - bun create fuwari@latest |
44 | | - deno run -A npm:create-fuwari@latest |
45 | | - ``` |
46 | | -2. To edit your blog locally, clone your repository, run `pnpm install` to install dependencies. |
47 | | - - Install [pnpm](https://pnpm.io) `npm install -g pnpm` if you haven't. |
48 | | -3. Edit the config file `src/config.ts` to customize your blog. |
49 | | -4. Run `pnpm new-post <filename>` to create a new post and edit it in `src/content/posts/`. |
50 | | -5. Deploy your blog to Vercel, Netlify, GitHub Pages, etc. following [the guides](https://docs.astro.build/en/guides/deploy/). You need to edit the site configuration in `astro.config.mjs` before deployment. |
51 | | -
|
52 | | -## 📝 Frontmatter of Posts |
| 1 | +# acapz.dev |
| 2 | + |
| 3 | +`acapz.dev`는 [Astro](https://astro.build) 기반 정적 블로그입니다. [Fuwari](https://github.com/saicaca/fuwari) 테마를 바탕으로 개인 블로그 용도에 맞게 커스터마이즈했습니다. |
| 4 | + |
| 5 | +개발 기록, 프로젝트 회고, 에세이, 나중에 다시 읽고 싶은 글을 남기기 위한 저장소입니다. |
| 6 | + |
| 7 | +## 기술 스택 |
| 8 | + |
| 9 | +- [Astro](https://astro.build) |
| 10 | +- [Svelte](https://svelte.dev) |
| 11 | +- [Tailwind CSS](https://tailwindcss.com) |
| 12 | +- [Pagefind](https://pagefind.app) |
| 13 | +- [Biome](https://biomejs.dev) |
| 14 | +- [pnpm](https://pnpm.io) |
| 15 | + |
| 16 | +## 요구 사항 |
| 17 | + |
| 18 | +- Node.js 20 이상 |
| 19 | +- pnpm 9 이상 |
| 20 | + |
| 21 | +이 저장소는 `preinstall` 스크립트로 pnpm 사용을 강제합니다. |
| 22 | + |
| 23 | +## 로컬 실행 |
| 24 | + |
| 25 | +```sh |
| 26 | +pnpm install |
| 27 | +pnpm dev |
| 28 | +``` |
| 29 | + |
| 30 | +기본 개발 서버 주소는 `http://localhost:4321`입니다. |
| 31 | + |
| 32 | +## 글 작성 |
| 33 | + |
| 34 | +새 글은 다음 명령어로 생성합니다. |
| 35 | + |
| 36 | +```sh |
| 37 | +pnpm new-post <filename> |
| 38 | +``` |
| 39 | + |
| 40 | +글 파일은 `src/content/posts/` 아래에 생성됩니다. 기본 frontmatter 형식은 다음과 같습니다. |
53 | 41 |
|
54 | 42 | ```yaml |
55 | 43 | --- |
56 | | -title: My First Blog Post |
57 | | -published: 2023-09-09 |
58 | | -description: This is the first post of my new Astro blog. |
59 | | -image: ./cover.jpg |
60 | | -tags: [Foo, Bar] |
61 | | -category: Front-end |
| 44 | +title: My Post |
| 45 | +published: 2026-07-06 |
| 46 | +description: Short description |
| 47 | +image: '' |
| 48 | +tags: [Essay] |
| 49 | +category: Essay |
62 | 50 | draft: false |
63 | | -lang: jp # Set only if the post's language differs from the site's language in `config.ts` |
| 51 | +lang: '' |
64 | 52 | --- |
65 | 53 | ``` |
66 | 54 |
|
67 | | -## 🧩 Markdown Extended Syntax |
68 | | -
|
69 | | -In addition to Astro's default support for [GitHub Flavored Markdown](https://github.github.com/gfm/), several extra Markdown features are included: |
70 | | - |
71 | | -- Admonitions ([Preview and Usage](https://fuwari.vercel.app/posts/markdown-extended/#admonitions)) |
72 | | -- GitHub repository cards ([Preview and Usage](https://fuwari.vercel.app/posts/markdown-extended/#github-repository-cards)) |
73 | | -- Enhanced code blocks with Expressive Code ([Preview](https://fuwari.vercel.app/posts/expressive-code/) / [Docs](https://expressive-code.com/)) |
| 55 | +공개하지 않을 글은 `draft: true`로 설정합니다. |
| 56 | + |
| 57 | +## 명령어 |
| 58 | + |
| 59 | +| 명령어 | 설명 | |
| 60 | +|:--|:--| |
| 61 | +| `pnpm dev` | 로컬 개발 서버를 실행합니다 | |
| 62 | +| `pnpm build` | 프로덕션 사이트와 Pagefind 검색 인덱스를 빌드합니다 | |
| 63 | +| `pnpm preview` | 프로덕션 빌드를 로컬에서 미리 봅니다 | |
| 64 | +| `pnpm check` | Astro 검사를 실행합니다 | |
| 65 | +| `pnpm type-check` | TypeScript 타입 검사를 실행합니다 | |
| 66 | +| `pnpm format` | Biome으로 `src`를 포맷합니다 | |
| 67 | +| `pnpm lint` | Biome 검사를 실행하고 `src`에 수정 가능한 변경을 적용합니다 | |
| 68 | +| `pnpm new-post <filename>` | 새 글 파일을 생성합니다 | |
| 69 | + |
| 70 | +## 프로젝트 구조 |
| 71 | + |
| 72 | +```text |
| 73 | +src/ |
| 74 | + components/ UI 컴포넌트 |
| 75 | + content/ |
| 76 | + posts/ 블로그 글 |
| 77 | + spec/ 정적 콘텐츠 페이지 |
| 78 | + i18n/ 다국어 문구 |
| 79 | + layouts/ 페이지 레이아웃 |
| 80 | + pages/ Astro 라우트 |
| 81 | + styles/ 전역 스타일 |
| 82 | + config.ts 사이트, 프로필, 내비게이션, 라이선스 설정 |
| 83 | +public/ 정적 공개 파일 |
| 84 | +scripts/ 유틸리티 스크립트 |
| 85 | +``` |
74 | 86 |
|
75 | | -## ⚡ Commands |
| 87 | +## 배포 |
76 | 88 |
|
77 | | -All commands are run from the root of the project, from a terminal: |
| 89 | +사이트 주소는 `astro.config.mjs`에 다음과 같이 설정되어 있습니다. |
78 | 90 |
|
79 | | -| Command | Action | |
80 | | -|:---------------------------|:----------------------------------------------------| |
81 | | -| `pnpm install` | Installs dependencies | |
82 | | -| `pnpm dev` | Starts local dev server at `localhost:4321` | |
83 | | -| `pnpm build` | Build your production site to `./dist/` | |
84 | | -| `pnpm preview` | Preview your build locally, before deploying | |
85 | | -| `pnpm check` | Run checks for errors in your code | |
86 | | -| `pnpm format` | Format your code using Biome | |
87 | | -| `pnpm new-post <filename>` | Create a new post | |
88 | | -| `pnpm astro ...` | Run CLI commands like `astro add`, `astro check` | |
89 | | -| `pnpm astro --help` | Get help using the Astro CLI | |
| 91 | +```js |
| 92 | +site: "https://acapz.dev/" |
| 93 | +``` |
90 | 94 |
|
91 | | -## ✏️ Contributing |
| 95 | +프로덕션 빌드는 다음 명령어로 생성합니다. |
92 | 96 |
|
93 | | -Check out the [Contributing Guide](https://github.com/saicaca/fuwari/blob/main/CONTRIBUTING.md) for details on how to contribute to this project. |
| 97 | +```sh |
| 98 | +pnpm build |
| 99 | +``` |
94 | 100 |
|
95 | | -## 📄 License |
| 101 | +빌드 결과물은 `dist/`에 생성됩니다. |
96 | 102 |
|
97 | | -This project is licensed under the MIT License. |
| 103 | +## 라이선스 |
98 | 104 |
|
99 | | -[](https://app.fossa.com/projects/git%2Bgithub.qkg1.top%2Fsaicaca%2Ffuwari?ref=badge_large&issueType=license) |
| 105 | +소스 코드는 upstream Fuwari와 동일하게 MIT 라이선스를 따릅니다. 블로그 글과 작성 콘텐츠는 사이트 설정상 [CC BY-NC-SA 4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/)을 사용합니다. |
0 commit comments