From f817e930ece65ead8c2438d9bc4de77a27ef5ec8 Mon Sep 17 00:00:00 2001 From: saicaca Date: Mon, 22 Jul 2024 01:09:03 +0800 Subject: [PATCH] docs: update README --- README.ja-JP.md | 35 +++++++++++++++++++---------------- README.ko.md | 5 ++++- README.md | 12 +++++++++--- README.zh-CN.md | 5 ++++- 4 files changed, 36 insertions(+), 21 deletions(-) diff --git a/README.ja-JP.md b/README.ja-JP.md index 8b94d94..ab93365 100644 --- a/README.ja-JP.md +++ b/README.ja-JP.md @@ -1,14 +1,17 @@ # 🍥Fuwari -[Astro](https://astro.build)で構築された静的ブログテンプレート +[Astro](https://astro.build) で構築された静的ブログテンプレート -[**🖥️ライブデモ (Vercel)**](https://fuwari.vercel.app)   /   [**🌏中文**](https://github.com/saicaca/fuwari/blob/main/README.zh-CN.md)   /   [**🌏日本語**](https://github.com/saicaca/fuwari/blob/main/README.ja-JP.md)   /   [**🌏한국어 README**](https://github.com/saicaca/fuwari/blob/main/README.ko.md)   /   [**📦旧Hexoバージョン**](https://github.com/saicaca/hexo-theme-vivia) +[**🖥️ライブデモ (Vercel)**](https://fuwari.vercel.app)   /    +[**📦旧 Hexo バージョン**](https://github.com/saicaca/hexo-theme-vivia) + +> README バージョン：`2024-04-07` ![Preview Image](https://raw.githubusercontent.com/saicaca/resource/main/fuwari/home.png) ## ✨ 特徴 -- [x] [Astro](https://astro.build)及び [Tailwind CSS](https://tailwindcss.com)で構築 +- [x] [Astro](https://astro.build) 及び [Tailwind CSS](https://tailwindcss.com) で構築 - [x] スムーズなアニメーションとページ遷移 - [x] ライト/ダークテーマ対応 - [x] カスタマイズ可能なテーマカラーとバナー @@ -21,10 +24,10 @@ 1. [テンプレート](https://github.com/saicaca/fuwari/generate)から新しいリポジトリを作成するかCloneをします。 2. ブログをローカルで編集するには、リポジトリをクローンした後、`pnpm install` と `pnpm add sharp` を実行して依存関係をインストールします。 - - [pnpm](https://pnpm.io)がインストールされていない場合は `npm install -g pnpm` で導入可能です。 -3. `src/config.ts`ファイルを編集する事でブログを自分好みにカスタマイズ出来ます。 -4. `pnpm new-post `で新しい記事を作成し、`src/content/posts/`.フォルダ内で編集します。 -5. 作成したブログをVercel、Netlify、GitHub Pagesなどにデプロイするには[ガイド](https://docs.astro.build/ja/guides/deploy/)に従って下さい。加えて、別途デプロイを行う前に`astro.config.mjs`を編集してサイト構成を変更する必要があります。 + - [pnpm](https://pnpm.io) がインストールされていない場合は `npm install -g pnpm` で導入可能です。 +3. `src/config.ts` ファイルを編集する事でブログを自分好みにカスタマイズ出来ます。 +4. `pnpm new-post ` で新しい記事を作成し、`src/content/posts/`.フォルダ内で編集します。 +5. 作成したブログをVercel、Netlify、GitHub Pagesなどにデプロイするには[ガイド](https://docs.astro.build/ja/guides/deploy/)に従って下さい。加えて、別途デプロイを行う前に `astro.config.mjs` を編集してサイト構成を変更する必要があります。 ## ⚙️ 記事のフロントマター @@ -44,12 +47,12 @@ draft: false すべてのコマンドは、ターミナルでプロジェクトのルートから実行する必要があります: -| Command | Action | -|:------------------------------------|:-------------------------------------------------| -| `pnpm install` AND `pnpm add sharp` | 依存関係のインストール | -| `pnpm dev` | `localhost:4321`で開発用ローカルサーバーを起動 | -| `pnpm build` | `./dist/`にビルド内容を出力 | -| `pnpm preview` | デプロイ前の内容をローカルでプレビュー | -| `pnpm new-post ` | 新しい投稿を作成 | -| `pnpm astro ...` | `astro add`, `astro check`の様なコマンドを実行する際に使用 | -| `pnpm astro --help` | Astro CLIのヘルプを表示 | +| Command | Action | +|:------------------------------------|:--------------------------------------------| +| `pnpm install` AND `pnpm add sharp` | 依存関係のインストール | +| `pnpm dev` | `localhost:4321` で開発用ローカルサーバーを起動 | +| `pnpm build` | `./dist/` にビルド内容を出力 | +| `pnpm preview` | デプロイ前の内容をローカルでプレビュー | +| `pnpm new-post ` | 新しい投稿を作成 | +| `pnpm astro ...` | `astro add`, `astro check` の様なコマンドを実行する際に使用 | +| `pnpm astro --help` | Astro CLIのヘルプを表示 | diff --git a/README.ko.md b/README.ko.md index 69c1215..75b7918 100644 --- a/README.ko.md +++ b/README.ko.md @@ -2,7 +2,10 @@ [Astro](https://astro.build)로 구축된 정적 블로그 템플릿입니다. -[**🖥️미리보기 (Vercel)**](https://fuwari.vercel.app)   /   [**🌏中文 README**](https://github.com/saicaca/fuwari/blob/main/README.zh-CN.md)   /   [**🌏日本語 README**](https://github.com/saicaca/fuwari/blob/main/README.ja-JP.md)   /   [**🌏한국어 README**](https://github.com/saicaca/fuwari/blob/main/README.ko.md)   /   [**📦Old Hexo Version**](https://github.com/saicaca/hexo-theme-vivia) +[**🖥️미리보기 (Vercel)**](https://fuwari.vercel.app)   /    +[**📦Old Hexo Version**](https://github.com/saicaca/hexo-theme-vivia) + +> README 버전: `2024-04-07` ![Preview Image](https://raw.githubusercontent.com/saicaca/resource/main/fuwari/home.png) diff --git a/README.md b/README.md index 7b43023..957ce27 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,13 @@ A static blog template built with [Astro](https://astro.build). -[**🖥️Live Demo (Vercel)**](https://fuwari.vercel.app)   /   [**🌏中文 README**](https://github.com/saicaca/fuwari/blob/main/README.zh-CN.md)   /   [**🌏日本語 README**](https://github.com/saicaca/fuwari/blob/main/README.ja-JP.md)   /   [**🌏한국어 README**](https://github.com/saicaca/fuwari/blob/main/README.ko.md)   /   [**📦Old Hexo Version**](https://github.com/saicaca/hexo-theme-vivia) +[**🖥️ Live Demo (Vercel)**](https://fuwari.vercel.app)   /    +[**📦 Old Hexo Version**](https://github.com/saicaca/hexo-theme-vivia)   /    +[**🌏 中文**](https://github.com/saicaca/fuwari/blob/main/README.zh-CN.md)   /    +[**🌏 日本語**](https://github.com/saicaca/fuwari/blob/main/README.ja-JP.md)   /    +[**🌏 한국어**](https://github.com/saicaca/fuwari/blob/main/README.ko.md) + +> README version: `2024-04-07` ![Preview Image](https://raw.githubusercontent.com/saicaca/resource/main/fuwari/home.png) @@ -20,11 +26,11 @@ A static blog template built with [Astro](https://astro.build). ## 🚀 How to Use 1. [Generate a new repository](https://github.com/saicaca/fuwari/generate) from this template or fork this repository. -2. To edit your blog locally, clone your repository, run `pnpm install` AND `pnpm add sharp` to install dependencies. +2. To edit your blog locally, clone your repository, run `pnpm install` AND `pnpm add sharp` to install dependencies. - Install [pnpm](https://pnpm.io) `npm install -g pnpm` if you haven't. 3. Edit the config file `src/config.ts` to customize your blog. 4. Run `pnpm new-post ` to create a new post and edit it in `src/content/posts/`. -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. +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. ## ⚙️ Frontmatter of Posts diff --git a/README.zh-CN.md b/README.zh-CN.md index b496530..b2a7063 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -2,7 +2,10 @@ 基于 [Astro](https://astro.build) 开发的静态博客模板。 -[**🖥️在线预览（Vercel）**](https://fuwari.vercel.app)   /   [**🌏English README**](https://github.com/saicaca/fuwari)   /   [**🌏日本語 README**](https://github.com/saicaca/fuwari/blob/main/README.ja-JP.md)   /   [**🌏한국어 README**](https://github.com/saicaca/fuwari/blob/main/README.ko.md)   /   [**📦旧 Hexo 版本**](https://github.com/saicaca/hexo-theme-vivia) +[**🖥️在线预览（Vercel）**](https://fuwari.vercel.app)   /    +[**📦旧 Hexo 版本**](https://github.com/saicaca/hexo-theme-vivia) + +> README 版本：`2024-04-07` ![Preview Image](https://raw.githubusercontent.com/saicaca/resource/main/fuwari/home.png)