person_blog
Go to file
See-Night e5acc80042 docs:optimized usage instructions 2024-04-07 00:31:07 +08:00
.vscode feat: add FrontMatter CMS, biome, translation, etc. 2024-01-21 12:54:41 +08:00
public/favicon refactor: code cleanup 2024-02-18 18:26:40 +08:00
scripts refactor: code cleanup 2024-02-18 18:26:40 +08:00
src docs: update example posts 2024-04-05 12:33:07 +08:00
.gitignore feat: initial commit 2023-10-18 02:15:21 +08:00
LICENSE chore: create LICENSE 2023-10-20 12:14:06 +08:00
README.md docs:optimized usage instructions 2024-04-07 00:31:07 +08:00
README.zh-CN.md docs:optimized usage instructions 2024-04-07 00:31:07 +08:00
astro.config.mjs feat: use Swug for transition animations instead of ViewTransitions 2024-03-12 14:04:58 +08:00
biome.json feat: add FrontMatter CMS, biome, translation, etc. 2024-01-21 12:54:41 +08:00
frontmatter.json feat: add FrontMatter CMS, biome, translation, etc. 2024-01-21 12:54:41 +08:00
package.json chore: update dependencies 2024-03-16 01:19:23 +08:00
pnpm-lock.yaml chore: update dependencies 2024-03-16 01:19:23 +08:00
tailwind.config.cjs feat: add FrontMatter CMS, biome, translation, etc. 2024-01-21 12:54:41 +08:00
tsconfig.json feat: make 'uncategorized' a category 2024-01-21 20:21:04 +08:00
vercel.json fix: url `/page/1` -> `/`, `/page/2` -> `/2` 2024-02-18 18:26:40 +08:00

README.md

🍥Fuwari

A static blog template built with Astro.

🖥️Live Demo (Vercel)   /   🌏中文 README   /   📦Old Hexo Version

Preview Image

Features

  • Built with Astro and Tailwind CSS
  • Smooth animations and page transitions
  • Light / dark mode
  • Customizable theme colors & banner
  • Responsive design
  • Comments
  • Search
  • TOC

🚀 How to Use

  1. Generate a new repository 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 npm install -g pnpm if you haven't.
  3. Edit the config file src/config.ts to customize your blog.
  4. Change the site field in astro.config.mjs to your blog's domain.
  5. Run pnpm new-post <filename> to create a new post and edit it in src/content/posts/.
  6. 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]
category: Front-end
draft: false
---

🧞 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