Skip to content

Commit 83327ae

Browse files
fishcpyfishcpy
committed
更新描述文件
1 parent 378e67b commit 83327ae

File tree

2 files changed

+75
-70
lines changed

2 files changed

+75
-70
lines changed

‎README-zh-CN.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# 🐟 fishcpy 主题
2+
![Node.js >= 20](https://img.shields.io/badge/node.js-%3E%3D20-brightgreen)
3+
![pnpm >= 9](https://img.shields.io/badge/pnpm-%3E%3D9-blue)
4+
5+
> 基于[Astro](https://astro.build)构建的静态博客模板，由[Fuwari](https://github.com/saicaca/fuwari)修改而来。
6+
7+
[**🖥️ 实时演示 **](https://fishcpy-theme.demo.fis.ink)
8+
9+
![预览图](https://cdn.fis.ink/cdn/2025/09/06/68bb1a79306d1.webp)
10+
11+
🌏 中文版 README 在
12+
[**中文**](./README-zh-CN.md)
13+
*(由社区提供，内容可能未及时更新)*
14+
15+
---
16+
17+
## ✨ 核心特性
18+
19+
- [x] 基于 [Astro](https://astro.build) 与 [Tailwind CSS](https://tailwindcss.com) 构建
20+
- [x] 流畅动画与页面过渡效果
21+
- [x] 浅色/深色模式
22+
- [x] 可自定义主题配色与横幅
23+
- [x] 响应式设计
24+
- [x] 搭载[Pagefind](https://pagefind.app/)的搜索功能
25+
- [x] [Markdown扩展功能](https://github.com/saicaca/fuwari?tab=readme-ov-file#-markdown-extended-syntax)
26+
- [x] 目录功能
27+
- [x] RSS订阅源
28+
- [x] Twikoo与artalk评论区
29+
30+
## ⚡ 命令列表
31+
32+
| 命令 | 操作 |
33+
|----------------------------|-----------------------------------------------------|
34+
| `pnpm install` | 安装依赖项 |
35+
| `pnpm dev` | 在 `localhost:4321` 启动开发服务器 |
36+
| `pnpm build` | 将生产站点构建至 `./dist/` |
37+
| `pnpm preview` | 部署前预览构建站点 |
38+
| `pnpm check` | 运行代码质量与类型检查 |
39+
| `pnpm format` | 使用 Biome 格式化代码 |
40+
| `pnpm new-post <文件名>` | 创建新博客文章 |
41+
| `pnpm astro ...` | 运行 Astro CLI 命令（例如 `astro add`） |
42+
| `pnpm astro --help` | 显示 Astro CLI 帮助 |
43+
44+
## 📄 许可协议
45+
46+
本项目采用 MIT 许可协议授权。
47+
48+
基于 [Fuwari](https://github.com/saicaca/fuwari) 修改而来。
49+
50+
[![FOSSA 状态](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fsaicaca%2Ffuwari.svg? type=large&issueType=license)](https://app.fossa.com/projects/git%2Bgithub.com%2Fsaicaca%2Ffuwari?ref=badge_large&issueType=license)
51+
52+
通过DeepL.com（免费版）翻译

‎README.md

Lines changed: 23 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,18 @@
1-
# 🍥Fuwari
1+
# 🐟 fishcpy theme
22
![Node.js >= 20](https://img.shields.io/badge/node.js-%3E%3D20-brightgreen)
33
![pnpm >= 9](https://img.shields.io/badge/pnpm-%3E%3D9-blue)
4-
[![DeepWiki](https://img.shields.io/badge/DeepWiki-saicaca%2Ffuwari-blue.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACwAAAAyCAYAAAAnWDnqAAAAAXNSR0IArs4c6QAAA05JREFUaEPtmUtyEzEQhtWTQyQLHNak2AB7ZnyXZMEjXMGeK/AIi+QuHrMnbChYY7MIh8g01fJoopFb0uhhEqqcbWTp06/uv1saEDv4O3n3dV60RfP947Mm9/SQc0ICFQgzfc4CYZoTPAswgSJCCUJUnAAoRHOAUOcATwbmVLWdGoH//PB8mnKqScAhsD0kYP3j/Yt5LPQe2KvcXmGvRHcDnpxfL2zOYJ1mFwrryWTz0advv1Ut4CJgf5uhDuDj5eUcAUoahrdY/56ebRWeraTjMt/00Sh3UDtjgHtQNHwcRGOC98BJEAEymycmYcWwOprTgcB6VZ5JK5TAJ+fXGLBm3FDAmn6oPPjR4rKCAoJCal2eAiQp2x0vxTPB3ALO2CRkwmDy5WohzBDwSEFKRwPbknEggCPB/imwrycgxX2NzoMCHhPkDwqYMr9tRcP5qNrMZHkVnOjRMWwLCcr8ohBVb1OMjxLwGCvjTikrsBOiA6fNyCrm8V1rP93iVPpwaE+gO0SsWmPiXB+jikdf6SizrT5qKasx5j8ABbHpFTx+vFXp9EnYQmLx02h1QTTrl6eDqxLnGjporxl3NL3agEvXdT0WmEost648sQOYAeJS9Q7bfUVoMGnjo4AZdUMQku50McDcMWcBPvr0SzbTAFDfvJqwLzgxwATnCgnp4wDl6Aa+Ax283gghmj+vj7feE2KBBRMW3FzOpLOADl0Isb5587h/U4gGvkt5v60Z1VLG8BhYjbzRwyQZemwAd6cCR5/XFWLYZRIMpX39AR0tjaGGiGzLVyhse5C9RKC6ai42ppWPKiBagOvaYk8lO7DajerabOZP46Lby5wKjw1HCRx7p9sVMOWGzb/vA1hwiWc6jm3MvQDTogQkiqIhJV0nBQBTU+3okKCFDy9WwferkHjtxib7t3xIUQtHxnIwtx4mpg26/HfwVNVDb4oI9RHmx5WGelRVlrtiw43zboCLaxv46AZeB3IlTkwouebTr1y2NjSpHz68WNFjHvupy3q8TFn3Hos2IAk4Ju5dCo8B3wP7VPr/FGaKiG+T+v+TQqIrOqMTL1VdWV1DdmcbO8KXBz6esmYWYKPwDL5b5FA1a0hwapHiom0r/cKaoqr+27/XcrS5UwSMbQAAAABJRU5ErkJggg==)](https://deepwiki.com/saicaca/fuwari)
5-
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fsaicaca%2Ffuwari.svg?type=shield&issueType=license)](https://app.fossa.com/projects/git%2Bgithub.com%2Fsaicaca%2Ffuwari?ref=badge_shield&issueType=license)
64

7-
A static blog template built with [Astro](https://astro.build).
5+
> A static blog template built with [Astro](https://astro.build), modified from [Fuwari](https://github.com/saicaca/fuwari).
86
9-
[**🖥️ Live Demo (Vercel)**](https://fuwari.vercel.app)
7+
[**🖥️ Live Demo **](https://fishcpy-theme.demo.fis.ink)
108

11-
![Preview Image](https://raw.githubusercontent.com/saicaca/resource/main/fuwari/home.png)
9+
![Preview Image](https://cdn.fis.ink/cdn/2025/09/06/68bb1a79306d1.webp)
1210

13-
🌏 README in
14-
[**中文**](https://github.com/saicaca/fuwari/blob/main/docs/README.zh-CN.md) /
15-
[**日本語**](https://github.com/saicaca/fuwari/blob/main/docs/README.ja.md) /
16-
[**한국어**](https://github.com/saicaca/fuwari/blob/main/docs/README.ko.md) /
17-
[**Español**](https://github.com/saicaca/fuwari/blob/main/docs/README.es.md) /
18-
[**ไทย**](https://github.com/saicaca/fuwari/blob/main/docs/README.th.md) (Provided by the community and may not always be up-to-date)
11+
🌏 README in
12+
[**中文**](./README-zh-CN.md)
13+
*(Provided by the community and may not always be up-to-date)*
14+
15+
---
1916

2017
## ✨ Features
2118

@@ -28,70 +25,26 @@ A static blog template built with [Astro](https://astro.build).
2825
- [x] [Markdown extended features](https://github.com/saicaca/fuwari?tab=readme-ov-file#-markdown-extended-syntax)
2926
- [x] Table of contents
3027
- [x] RSS feed
31-
32-
## 🚀 Getting Started
33-
34-
1. Create your blog repository:
35-
- [Generate a new repository](https://github.com/saicaca/fuwari/generate) from this template or fork this repository.
36-
- Or run one of the following commands:
37-
```sh
38-
npm create fuwari@latest
39-
yarn create fuwari
40-
pnpm create fuwari@latest
41-
bun create fuwari@latest
42-
deno run -A npm:create-fuwari@latest
43-
```
44-
2. To edit your blog locally, clone your repository, run `pnpm install` to install dependencies.
45-
- Install [pnpm](https://pnpm.io) `npm install -g pnpm` if you haven't.
46-
3. Edit the config file `src/config.ts` to customize your blog.
47-
4. Run `pnpm new-post <filename>` to create a new post and edit it in `src/content/posts/`.
48-
5. Deploy your blog to Vercel, Netlify, GitHub Pages, etc. following [the guides](https://docs.astro.build/en/guides/deploy/). You need to edit the site configuration in `astro.config.mjs` before deployment.
49-
50-
## 📝 Frontmatter of Posts
51-
52-
```yaml
53-
---
54-
title: My First Blog Post
55-
published: 2023-09-09
56-
description: This is the first post of my new Astro blog.
57-
image: ./cover.jpg
58-
tags: [Foo, Bar]
59-
category: Front-end
60-
draft: false
61-
lang: jp # Set only if the post's language differs from the site's language in `config.ts`
62-
---
63-
```
64-
65-
## 🧩 Markdown Extended Syntax
66-
67-
In addition to Astro's default support for [GitHub Flavored Markdown](https://github.github.com/gfm/), several extra Markdown features are included:
68-
69-
- Admonitions ([Preview and Usage](https://fuwari.vercel.app/posts/markdown-extended/#admonitions))
70-
- GitHub repository cards ([Preview and Usage](https://fuwari.vercel.app/posts/markdown-extended/#github-repository-cards))
71-
- Enhanced code blocks with Expressive Code ([Preview](https://fuwari.vercel.app/posts/expressive-code/) / [Docs](https://expressive-code.com/))
28+
- [x] Twikoo and artalk comment sections
7229

7330
## ⚡ Commands
7431

75-
All commands are run from the root of the project, from a terminal:
76-
7732
| Command | Action |
78-
|:---------------------------|:----------------------------------------------------|
79-
| `pnpm install` | Installs dependencies |
80-
| `pnpm dev` | Starts local dev server at `localhost:4321` |
81-
| `pnpm build` | Build your production site to `./dist/` |
82-
| `pnpm preview` | Preview your build locally, before deploying |
83-
| `pnpm check` | Run checks for errors in your code |
84-
| `pnpm format` | Format your code using Biome |
85-
| `pnpm new-post <filename>` | Create a new post |
86-
| `pnpm astro ...` | Run CLI commands like `astro add`, `astro check` |
87-
| `pnpm astro --help` | Get help using the Astro CLI |
88-
89-
## ✏️ Contributing
90-
91-
Check out the [Contributing Guide](https://github.com/saicaca/fuwari/blob/main/CONTRIBUTING.md) for details on how to contribute to this project.
33+
|----------------------------|-----------------------------------------------------|
34+
| `pnpm install` | Install dependencies |
35+
| `pnpm dev` | Start dev server at `localhost:4321` |
36+
| `pnpm build` | Build production site to `./dist/` |
37+
| `pnpm preview` | Preview built site before deploying |
38+
| `pnpm check` | Run code quality and type checks |
39+
| `pnpm format` | Format code using Biome |
40+
| `pnpm new-post <filename>` | Create a new blog post |
41+
| `pnpm astro ...` | Run Astro CLI commands (e.g., `astro add`) |
42+
| `pnpm astro --help` | Show Astro CLI help |
9243

9344
## 📄 License
9445

9546
This project is licensed under the MIT License.
9647

97-
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fsaicaca%2Ffuwari.svg?type=large&issueType=license)](https://app.fossa.com/projects/git%2Bgithub.com%2Fsaicaca%2Ffuwari?ref=badge_large&issueType=license)
48+
Modified from [Fuwari](https://github.com/saicaca/fuwari).
49+
50+
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fsaicaca%2Ffuwari.svg?type=large&issueType=license)](https://app.fossa.com/projects/git%2Bgithub.com%2Fsaicaca%2Ffuwari?ref=badge_large&issueType=license)

0 commit comments

Comments
 (0)