docs: update README

This commit is contained in:
saicaca
2024-07-22 01:09:03 +08:00
parent 96223c0b5a
commit f817e930ec
4 changed files with 36 additions and 21 deletions

View File

@@ -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 <filename>` 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