64 lines
3.0 KiB
Markdown
64 lines
3.0 KiB
Markdown
# 🍥Fuwari
|
|
|
|
A static blog template built with [Astro](https://astro.build).
|
|
|
|
[**🖥️ 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) /
|
|
[**🌏 Español**](https://github.com/saicaca/fuwari/blob/main/README.es.md)
|
|
|
|
> README version: `2024-09-10`
|
|
|
|
|
|
|
|
## ✨ Features
|
|
|
|
- [x] Built with [Astro](https://astro.build) and [Tailwind CSS](https://tailwindcss.com)
|
|
- [x] Smooth animations and page transitions
|
|
- [x] Light / dark mode
|
|
- [x] Customizable theme colors & banner
|
|
- [x] Responsive design
|
|
- [ ] Comments
|
|
- [x] Search
|
|
- [ ] TOC
|
|
|
|
## 🚀 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.
|
|
- 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.
|
|
|
|
## ⚙️ Frontmatter of Posts
|
|
|
|
```yaml
|
|
---
|
|
title: My First Blog Post
|
|
published: 2023-09-09
|
|
description: This is the first post of my new Astro blog.
|
|
image: ./cover.jpg
|
|
tags: [Foo, Bar]
|
|
category: Front-end
|
|
draft: false
|
|
lang: jp # Set only if the post's language differs from the site's language in `config.ts`
|
|
---
|
|
```
|
|
|
|
## 🧞 Commands
|
|
|
|
All commands are run from the root of the project, from a terminal:
|
|
|
|
| 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 |
|