https://github.com/innei/Shiro
📜 A minimalist personal website embodying the purity of paper and freshness of snow.
https://github.com/innei/Shiro
Last synced: 4 months ago
JSON representation
📜 A minimalist personal website embodying the purity of paper and freshness of snow.
- Host: GitHub
- URL: https://github.com/innei/Shiro
- Owner: Innei
- License: other
- Created: 2023-03-14T12:47:43.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2026-02-14T22:03:46.000Z (4 months ago)
- Last Synced: 2026-02-15T05:57:39.218Z (4 months ago)
- Language: TypeScript
- Homepage: https://innei.in
- Size: 16.9 MB
- Stars: 4,131
- Watchers: 11
- Forks: 883
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-blog-themes - Shiro
README
# Shiro
> **重要声明：** 由于个人精力有限，开源版本的 Shiro 后续将不再积极维护，仅会在发现重要安全漏洞时进行修复。我将把主要精力投入到赞助版 [白い](https://github.com/innei-dev/Shiroi) 的维护和功能迭代中。开源版本依然可以正常使用，感谢大家的理解和支持。
一个极简主义的个人网站主题，如纸的纯净，似雪的清新。
专为 [Mix Space](https://github.com/mx-space) 生态系统设计的现代化个人站点前端。
## :sparkles: 示例站点
以下是一些使用 Shiro 主题的精美站点：
- [静かな森](https://innei.in)
- [可愛い松](https://blog.wibus.ren/)
- [启动台の博客](https://www.launchpadx.top/)
欢迎体验 Shiro 带来的极简之美！
## :rocket: 核心特性
- **:zap: 极致性能**：在 LightHouse 测试中表现卓越，Performance 和 Best Practice 均超过 90%
- **:art: 现代设计**：简洁而不简单的用户界面，提供流畅优雅的用户体验
- **:gem: 细节至上**：采用符合物理学的 Spring 弹性动画，每一帧都如自然般舒适
- **:bell: 实时通知**：通过 WebSocket 连接，访客可实时接收最新文章推送
- **:computer: 活动状态**：结合 [ProcessReporter](https://github.com/Innei/ProcessReporter)，在主页展示实时活动状态
- **:pencil: 扩展语法**：支持丰富的 Markdown 扩展语法，满足多样化写作需求
- **:wrench: 轻量管理**：内置轻量级管理面板，便于内容管理
## :gear: 技术架构
基于现代化的前端技术栈构建：
- **NextJS** (App Router) - React 全栈框架
- **Jotai** - 原子化状态管理
- **Framer Motion** - 流畅动画库
- **Radix UI** - 无障碍组件库
- **Socket.IO** - 实时通信
- **TailwindCSS** - 原子化 CSS 框架
## 📖 部署指南
详细的部署教程请参考：https://mx-space.js.org/docs/themes/shiro/deploy
感谢 @wibus-wee、@wuhang2003 等社区贡献者编写的详细文档。
## :camera: 界面预览
**轻量级管理面板：**
点击查看更多完整页面截图
## :zap: 性能测试
在 M2 MacBook Air 环境下对重负载页面的性能测试结果：
## :whale: 快速开始
### :package: 预构建版本
从 [Releases](https://github.com/Innei/Shiro/releases) 页面下载最新的 `release.zip` 压缩包并解压：
```bash
cd standalone
vim .env # 配置环境变量
export PORT=2323
node server.js
```
### :docker: Docker Compose（推荐）
```bash
mkdir shiro && cd shiro
wget https://raw.githubusercontent.com/Innei/Shiro/main/docker-compose.yml
wget https://raw.githubusercontent.com/Innei/Shiro/main/.env.template .env
vim .env # 配置环境变量
mkdir public # 放置自定义 Favicon
docker compose up -d
# 后续更新
docker compose pull
```
## :memo: Markdown 扩展
了解更多 Markdown 扩展语法，请访问：https://shiro.innei.in/#/markdown
## :star: 白い (Shiroi) - 赞助版
[白い](https://github.com/innei-dev/Shiroi) 是 Shiro 的付费赞助版本，包含更多功能和持续更新。以下是赞助版相对于开源版的新增功能：
### :globe_with_meridians: 国际化系统
- 路由级本地化支持（`/[locale]/...`）
- 内容翻译状态展示和原文/翻译切换
- 翻译标记徽章
- 多语言消息文件（中文、英文、日文）
- dayjs 本地化同步
### :robot: AI 智能功能
- AI 智能摘要生成
- AI 内容翻译系统（支持实时翻译推送）
- AI 生成标记系统（支持标记翻译、摘要、自动生成等内容来源）
### :sparkles: 高级视觉效果
- WebGPU 雪花背景效果（高级粒子物理系统）
- 萤火虫粒子效果
- 纹理背景系统
- OKLCH 颜色空间主题生成
- 噪声背景生成
### :busts_in_silhouette: 实时协作
- Socket.IO 房间管理
- 在线用户实时展示（Presence 组件）
- 活动流实时更新
- 访客信息追踪
### :bulb: 思考（Recently）系统增强
- 独立的思考详情页
- 思考内容支持评论
- 点赞/点踩交互
- 思考 RSS Feed
- 思考内容引用其他文章功能
### :bookmark_tabs: 分类和标签
- 分类浏览主页 `/categories`
- 分类详情页 `/categories/[slug]`
- 按标签浏览文章 `/posts/tag/[name]`
### :house: 首页增强
- 精心设计的 Hero 区域（动画文本、一言、社交图标）
- 风向标导航组件
- 首页时间线展示
- 活动流屏幕
- 响应式两栏布局
### :lock: 认证系统
- Passkey 无密码认证支持
- Passkey 管理页面（创建、列表）
- 密码认证
- 完整的登录页面
### :speech_balloon: 评论系统增强
- 评论内联编辑功能
- 评论操作按钮组（编辑/回复）
- 更细粒度的权限控制（所有者/原评论者可编辑）
- 平滑的高度动画过渡
### :bar_chart: 后台系统增强
- 完整的仪表盘界面
- Lexical 富文本编辑器
- 文章/笔记编辑器增强
- IP 信息展示
- 每日诗词展示（今日诗词 API）
- AI 生成标记编辑
- 封面图输入增强
- 元数据 KV 编辑
- 新版表情选择器
### :chart_with_upwards_trend: 分析集成
- OpenPanel 用户行为分析
- 屏幕视图追踪
- 外链点击追踪
### :x: 移除的功能
赞助版为了专注核心功能，移除了以下开源版特性：
- Crossbell Web3 发布集成
- S3 云存储 API
## :heart: 致谢与许可
**© 2024 Innei** - 本项目采用 AGPLv3 许可证，并附加特定的商业使用条件。
使用本项目需要遵循 [附加条款和条件](ADDITIONAL_TERMS.md)。
**特别鸣谢：**
- 部分代码参考了 GPT-4 和 [cali.so](https://github.com/CaliCastle/cali.so)
- 感谢 Mix Space Team 和社区贡献者们的持续支持
---
> [个人网站](https://innei.in/) · GitHub [@Innei](https://github.com/innei/)