blog/README.md

2.1 KiB

Fuwari

[!WARNING] This project is still very unfinished and the code is quite messy. Features may be changed or removed in the future.

Fuwari (not the final name maybe) is a static blog template built with Astro, a refactored version of hexo-theme-vivia.

🖥️Live Demo (Vercel)

Features (Compared to the Hexo Version)

🚀 How to Use

  1. Fork this repo.
  2. Edit the config file fuwari.config.yml to customize your blog.
  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.

⚙️ Frontmatter of Posts

---
title: My First Blog Post
published: 2023-09-09
description: This is the first post of my new Astro blog.
image: /images/cover.jpg
tags: ['Foo', 'Bar']
---

🧞 Commands

All commands are run from the root of the project, from a terminal:

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