doc: update README
This commit is contained in:
parent
8848a25ec5
commit
f7efa010a2
|
@ -7,6 +7,8 @@ Fuwari (not the final name maybe) is a static blog template built with [Astro](h
|
||||||
|
|
||||||
[**🖥️Live Demo (Vercel)**](https://fuwari.vercel.app)
|
[**🖥️Live Demo (Vercel)**](https://fuwari.vercel.app)
|
||||||
|
|
||||||
|
![Preview Image](https://raw.githubusercontent.com/saicaca/resource/main/fuwari/home.png)
|
||||||
|
|
||||||
## ✨ Features
|
## ✨ Features
|
||||||
|
|
||||||
- [x] **Built with [Astro](https://astro.build) and [Tailwind CSS](https://tailwindcss.com)**
|
- [x] **Built with [Astro](https://astro.build) and [Tailwind CSS](https://tailwindcss.com)**
|
||||||
|
@ -21,7 +23,7 @@ Fuwari (not the final name maybe) is a static blog template built with [Astro](h
|
||||||
|
|
||||||
## 🚀 How to Use
|
## 🚀 How to Use
|
||||||
|
|
||||||
1. Fork this repo.
|
1. [Generate a new repository](https://github.com/saicaca/fuwari/generate) from this template.
|
||||||
2. Edit the config file `src/config.ts` to customize your blog.
|
2. Edit the config file `src/config.ts` to customize your blog.
|
||||||
3. Run `npm run new-post -- <filename>` to create a new post and edit it in `src/content/posts/`.
|
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/).
|
4. Deploy your blog to Vercel, Netlify, GitHub Pages, etc. following [the guides](https://docs.astro.build/en/guides/deploy/).
|
||||||
|
|
Loading…
Reference in New Issue