2024-03-17 15:06:29 +08:00
# 🍥Fuwari
2023-09-26 14:27:38 +08:00
2024-03-17 15:06:29 +08:00
A static blog template built with [Astro ](https://astro.build ).
2023-09-26 14:27:38 +08:00
2024-07-22 01:09:03 +08:00
[**🖥️ 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 ) /
2024-09-05 01:21:56 +08:00
[**🌏 한국어** ](https://github.com/saicaca/fuwari/blob/main/README.ko.md ) /
[**🌏 Español** ](https://github.com/saicaca/fuwari/blob/main/README.es.md )
2024-07-22 01:09:03 +08:00
2024-09-10 01:32:01 +08:00
> README version: `2024-09-10`
2023-09-26 14:27:38 +08:00
2023-11-25 16:32:10 +08:00
2023-10-22 12:06:39 +08:00
## ✨ Features
2024-03-17 15:06:29 +08:00
- [x] Built with [Astro ](https://astro.build ) and [Tailwind CSS ](https://tailwindcss.com )
- [x] Smooth animations and page transitions
2023-10-22 12:06:39 +08:00
- [x] Light / dark mode
- [x] Customizable theme colors & banner
- [x] Responsive design
- [ ] Comments
2024-01-25 12:18:50 +08:00
- [x] Search
2023-10-22 12:06:39 +08:00
- [ ] TOC
2023-09-26 14:27:38 +08:00
2023-10-18 17:53:14 +08:00
## 🚀 How to Use
2024-03-17 15:06:29 +08:00
1. [Generate a new repository ](https://github.com/saicaca/fuwari/generate ) from this template or fork this repository.
2024-07-22 01:09:03 +08:00
2. To edit your blog locally, clone your repository, run `pnpm install` AND `pnpm add sharp` to install dependencies.
2024-03-17 15:06:29 +08:00
- 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.
2024-04-07 00:47:28 +08:00
4. Run `pnpm new-post <filename>` to create a new post and edit it in `src/content/posts/` .
2024-07-22 01:09:03 +08:00
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.
2023-10-18 17:53:14 +08:00
## ⚙️ Frontmatter of Posts
```yaml
---
title: My First Blog Post
published: 2023-09-09
description: This is the first post of my new Astro blog.
2024-09-10 01:32:01 +08:00
image: ./cover.jpg
2023-11-07 12:35:52 +08:00
tags: [Foo, Bar]
category: Front-end
2024-01-21 20:19:34 +08:00
draft: false
2024-09-10 01:32:01 +08:00
lang: jp # Set only if the post's language differs from the site's language in `config.ts`
2023-10-18 17:53:14 +08:00
---
2023-09-26 14:27:38 +08:00
```
## 🧞 Commands
All commands are run from the root of the project, from a terminal:
2024-03-17 15:06:29 +08:00
| Command | Action |
|:------------------------------------|:-------------------------------------------------|
| `pnpm install` AND `pnpm add sharp` | Installs dependencies |
| `pnpm dev` | Starts local dev server at `localhost:4321` |
| `pnpm build` | Build your production site to `./dist/` |
| `pnpm preview` | Preview your build locally, before deploying |
| `pnpm new-post <filename>` | Create a new post |
| `pnpm astro ...` | Run CLI commands like `astro add` , `astro check` |
| `pnpm astro --help` | Get help using the Astro CLI |
