🍥Fuwari

A static blog template built with Astro.

This repository is based on the original template with personal modifications and optimizations. I have merged several PRs from the source repository, including features like link-cards and image-caption. Font styles and configurations have been modified to better meet personal needs. Additionally, to support the encrypted article feature, I have added an automated workflow to sync main and private branches.

🖥️ Live Demo (Vercel)

🌏 README in 中文 / 日本語 / 한국어 / Español / ไทย (Provided by the community and may not always be up-to-date)

✨ Features

• Built with Astro and Tailwind CSS
• Smooth animations and page transitions
• Light / dark mode
• Customizable theme colors & banner
• Responsive design
• Search functionality with Pagefind
• Markdown extended features
• Table of contents
• RSS feed
• Comments (Supports multiple systems like Disqus, Giscus, Twikoo)

🚀 Getting Started

1. Create your blog repository:

   • Generate a new repository from this template or fork this repository.

   • Or run one of the following commands:

     npm create fuwari@latest
     yarn create fuwari
     pnpm create fuwari@latest
     bun create fuwari@latest
     deno run -A npm:create-fuwari@latest

2. To edit your blog locally, clone your repository, run pnpm install 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. 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. You need to edit the site configuration in astro.config.mjs before deployment.

📝 Frontmatter of Posts

---
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
password: xxx (optional for encrypted articles)
lang: jp      # Set only if the post's language differs from the site's language in `config.ts`
---

🧩 Markdown Extended Syntax

In addition to Astro's default support for GitHub Flavored Markdown, several extra Markdown features are included:

• Admonitions (Preview and Usage)
• GitHub repository cards (Preview and Usage)
• Enhanced code blocks with Expressive Code (Preview / Docs)

⚡ Commands

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

Command	Action
pnpm install	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 check	Run checks for errors in your code
pnpm format	Format your code using Biome
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

✏️ Contributing

Check out the Contributing Guide for details on how to contribute to this project.

📄 License

This project is licensed under the MIT License.