🍥Fuwari CLI

本项目基于 saicaca/fuwari 改造，将原本的网站模板封装为npm库。使用fuwari命令将博客内容(.md)嵌入到Fuwari模板中，并启动或构建等

快速使用

Fuwari CLI 支持通过命令快速搭建、开发、构建自己的静态博客，只需关注 markdown 内容和配置。

目录结构

├── posts/              # 博客内容目录，存放所有 Markdown 文章（.md）
│    ├── hello-world.md
│    └── ...
├── fuwari.config.mjs   # 博客全局配置，主题/基本信息/导航等
├── package.json        # @byte.n/fuwari

快速使用 CLI

mkdir my-blog && cd my-blog
pnpm init -y
pnpm install @byte.n/fuwari

"scripts": {
  "dev": "fuwari dev",
  "build": "fuwari build",
  "preview": "fuwari preview"
},

🍥Fuwari 的介绍

A static blog template built with Astro.

🖥️ Live Demo (Vercel)

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

✨ Features

• [x] Built with Astro and Tailwind CSS
• [x] Smooth animations and page transitions
• [x] Light / dark mode
• [x] Customizable theme colors & banner
• [x] Responsive design
• [x] Search functionality with Pagefind
• [x] Markdown extended features
• [x] Table of contents
• [x] RSS feed

🚀 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
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.