# koi

**Repository Path**: rabbitTang_admin/koi

## Basic Information

- **Project Name**: koi
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-12-23
- **Last Updated**: 2026-01-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Koi (こい) - Astro Blog Template

Koi (こい, 恋) 是由 [tcdw](https://www.tcdw.net) 制作的一个高性能、设计精美的 Astro 静态博客模板。它结合了静态网站的速度优势和单页应用 (SPA) 的流畅体验。

![博客截图](./.github/assets/Astro%20Koi.jpeg)

## ✨ 特性

- **全局无刷 (SPA)**: 基于 [Swup](https://swup.js.org/) 实现页面无刷新切换，提供丝滑的浏览体验。
- **QWQ 加载器**: 内置可爱的颜文字加载动画，让等待不再枯燥（[查看演示](/qwq-demo)）。
- **响应式设计**: 完美适配移动端和桌面端各种屏幕尺寸。
- **双主题支持**: 明亮/暗黑模式自动切换（跟随系统设置）。
- **SEO 友好**: 静态生成的 HTML，对搜索引擎极度友好。
- **高性能**: 极少的客户端 JavaScript，首屏加载极快。
- **可访问性 (a11y)**: 符合 WCAG 规范，键盘与屏幕阅读器友好。
- **功能完备**: 内置搜索、RSS 订阅、站点地图、文章归档、友情链接等常用功能。
- **Markdown & MDX**: 支持标准的 Markdown 和 MDX 语法，内置 Mermaid 图表支持。

## 🛠️ 技术栈

- **[Astro 5.0](https://astro.build/)**: 下一代静态网站生成器。
- **[Tailwind CSS 4.0](https://tailwindcss.com/)**: 下一代原子化 CSS 框架。
- **[Svelte 5.0](https://svelte.dev/)**: 用于构建高性能的交互组件。
- **[Swup](https://swup.js.org/)**: 简单灵活的页面过渡库。
- **[TypeScript](https://www.typescriptlang.org/)**: 提供完整的类型安全支持。

## 🚀 快速开始

### 前置要求

- Node.js (v18.17.1 或更高版本)
- pnpm (推荐) 或 npm/yarn

### 安装与运行

1.  **克隆项目**

    ```bash
    git clone https://github.com/your-username/koi.git
    cd koi
    ```

2.  **安装依赖**

    ```bash
    pnpm install
    ```

3.  **启动开发服务器**

    ```bash
    pnpm dev
    ```

    访问 `http://localhost:4321` 即可预览。

4.  **构建生产版本**

    ```bash
    pnpm build
    ```

    构建产物将位于 `dist/` 目录。

5.  **创建新文章**

    ```bash
    pnpm new-post
    ```

## ⚙️ 配置

项目的主要配置位于 `src/consts.ts` 文件中，你可以修改以下内容：

- `SITE_TITLE`: 网站标题
- `SITE_DESCRIPTION`: 网站描述
- `SITE_AUTHOR_NAME`: 作者昵称
- `SITE_MENU`: 导航菜单链接
- 以及更多社交媒体链接和版权信息。

Astro 配置位于 `astro.config.js`，Tailwind 配置位于 `astro.config.js` (作为 vite 插件) 和 CSS 文件中。

## 📂 目录结构

```text
src/
├── assets/        # 静态资源（图片、字体等）
├── components/    # Svelte 和 Astro 组件
│   ├── friend/    # 友情链接相关组件
│   └── ...
├── content/       # 博客文章 (Markdown/MDX)
├── layouts/       # 页面布局 (Base, Blog, etc.)
├── pages/         # 路由页面
├── styles/        # 全局样式
└── utils/         # 工具函数
astro.config.js    # Astro 配置文件
package.json       # 项目依赖定义
```

## 📄 许可证

本项目遵循 [MIT 许可证](LICENSE) 发布。

---
Based on Koi by [tcdw](https://www.tcdw.net). 如果你喜欢这个模板，请保留页面底部的 Based on Koi 字样，谢谢w