2023-10-18 02:04:08 +08:00
# Fuwari
2023-09-26 14:27:38 +08:00
2023-10-18 02:04:08 +08:00
> [!WARNING]
2023-10-18 17:53:14 +08:00
> This project is still very unfinished and the code is quite messy. Features may be changed or removed in the future.
2023-10-18 02:04:08 +08:00
Fuwari (not the final name maybe) is a static blog template built with [Astro ](https://astro.build ), a refactored version of [hexo-theme-vivia ](https://github.com/saicaca/hexo-theme-vivia ).
2023-09-26 14:27:38 +08:00
2023-10-18 02:04:08 +08:00
[**🖥️ ](https://fuwari.vercel.app )
2023-09-26 14:27:38 +08:00
2023-10-22 12:06:39 +08:00
## ✨ Features
- [x] **Built with [Astro](https://astro.build) and [Tailwind CSS](https://tailwindcss.com)**
- [x] **View Transitions between pages**
2023-11-07 12:35:52 +08:00
- [is not supported by Firefox and Safari yet ](https://developer.mozilla.org/en-US/docs/Web/API/View_Transitions_API#browser_compatibility )
2023-10-22 12:06:39 +08:00
- [x] Light / dark mode
- [x] Customizable theme colors & banner
- [x] Responsive design
- [ ] Comments
- [ ] Search
- [ ] TOC
2023-09-26 14:27:38 +08:00
2023-10-18 17:53:14 +08:00
## 🚀 How to Use
1. Fork this repo.
2023-10-23 17:45:07 +08:00
2. Edit the config file `src/config.ts` to customize your blog.
2023-10-18 17:53:14 +08:00
3. Run `npm run new-post -- <filename>` to create a new post and edit it in `src/content/posts/` .
4. Deploy your blog to Vercel, Netlify, GitHub Pages, etc. following [the guides ](https://docs.astro.build/en/guides/deploy/ ).
## ⚙️ Frontmatter of Posts
```yaml
---
title: My First Blog Post
published: 2023-09-09
description: This is the first post of my new Astro blog.
2023-10-21 10:52:01 +08:00
image: /images/cover.jpg
2023-11-07 12:35:52 +08:00
tags: [Foo, Bar]
category: Front-end
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:
2023-10-18 17:53:14 +08:00
| Command | Action |
|:---------------------------------|:-------------------------------------------------|
| `npm install` | Installs dependencies |
| `npm run dev` | Starts local dev server at `localhost:4321` |
| `npm run build` | Build your production site to `./dist/` |
| `npm run preview` | Preview your build locally, before deploying |
| `npm run astro ...` | Run CLI commands like `astro add` , `astro check` |
| `npm run astro -- --help` | Get help using the Astro CLI |
| `npm run new-post -- <filename>` | Create a new post |
