xlu103 / shiro

📜 A minimalist personal website embodying the purity of paper and freshness of snow.

Shiro

一个极简主义的个人网站，体现了纸的纯净和雪的清新。

为 Mix Space 服务的个人站点前端。

以下是一些使用 Shiro 的示例站点：

• 静かな森
• 可愛い松
• HuaSui
• 天翔 TNXG
• Star

欢迎你来体验 Shiro 的魅力！

✨ 特征

1. 🚀 SEO 100%，性能优秀：在 LightHouse 中表现优秀，Performance > 90%，Best practice > 90%。
2. 🎨 UI 现代化，简洁不简单：用户界面设计现代化，简洁而不简单，让你的体验更加流畅。
3. 💎 注重细节，UX 极致：注重每一个细节，所有的动画都使用符合物理的 Spring 弹性动画，每一帧都是大自然的感觉。
4. 🔔 接入 WebSocket，实时获取最新的文章通知：通过 WebSocket，访客能够实时获取最新的文章通知。
5. 💻 实时活动状态展示：配合 ProcessReporter，可以在主页上显示实时活动状态。
6. 📝 Markdown 的扩展语法：支持更多的 Markdown 扩展语法，等待你的发掘和使用。

🔧 技术栈

• NextJS 13 (App Router)
• Jotai
• Framer motion
• Radix UI
• Socket.IO
• TailwindCSS

📄 使用文档

前往：https://mx-space.js.org/themes/shiro

感谢 @wibus-wee 和 @wuhang2003 等其他社区贡献者编写。

📷 截图

点击查看部分完整页面截图

⚡ 性能

在 M2 Macbook Air 环境中对逻辑最重的页面进行了测试。

🚀 部署

看这里.

🐳 Docker 部署

📚 docker-compose

1. change the args inside docker-compose.yml

2. run command

    docker-compose up -d

📦 docker run

docker build \
 --build-arg BASE_URL=REPLACE_WITH_YOUR_BASE_URL \
 --build-arg NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=REPLACE_WITH_YOUR_PUBLISHABLE_KEY \
 --build-arg CLERK_SECRET_KEY=REPLACE_WITH_YOUR_SECRET_KEY \
 -t shiro . --load

docker run --name shiro -d -p 2323:2323 shiro

Markdown 扩展语法

请阅读 https://shiro.innei.in/#/markdown

❤️ 鸣谢 & 许可

2023 © Innei，本项目采用 MIT 许可证发布。

部分代码由 GPT-4 和 cali.so 提供。

感谢 Mix Space Team 和广大社区朋友们的贡献。

个人网站 · GitHub @Innei