Skip to content
forked from Innei/Shiro

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

License

Notifications You must be signed in to change notification settings

James2234/Shiro

This branch is 237 commits behind Innei/Shiro:main.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

5820a43 · May 4, 2024
Apr 12, 2024
May 2, 2024
Feb 23, 2024
Feb 8, 2024
Apr 12, 2024
May 4, 2024
Apr 28, 2024
Jul 6, 2023
Feb 4, 2024
Apr 29, 2024
Apr 14, 2024
Feb 15, 2024
Mar 7, 2024
Dec 23, 2023
Apr 7, 2024
Mar 24, 2024
May 4, 2024
Mar 29, 2024
Mar 24, 2024
Feb 23, 2024
May 3, 2024
Jul 8, 2023
Feb 1, 2024
May 2, 2024
Apr 13, 2024
Mar 28, 2024
May 1, 2024
May 2, 2024
May 2, 2024
Jul 17, 2023
Jun 21, 2023
Apr 25, 2024
May 4, 2024
May 2, 2024
Apr 12, 2024
May 2, 2024
Apr 13, 2024
Apr 25, 2024
Jul 8, 2023
Mar 18, 2024

Repository files navigation

Shiro

一个极简主义的个人网站,纸的纯净和雪的清新。

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

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

欢迎你来体验 Shiro 的魅力!

✨ 特征

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

🔧 技术栈

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

📄 使用文档

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

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

📷 截图

Live Demo

轻管理面板:

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

页面截图 1 页面截图 2

⚡ 性能

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

🚀 部署

看这里.

🐳 运行

🔨 通过预构建运行

首先在 https://github.com/Innei/Shiro/releases 中下载预构建好的 release.zip。然后解压它。

cd standalone
vim .env # 修改你的 ENV 变量
export PORT=2323
node server.js

📚 推荐使用 Docker Compose

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 # 修改你的 ENV 变量
docker compose up -d

docker compose pull # 后续更新镜像

Markdown 扩展语法

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

❤️ 鸣谢 & 许可

2024 © Innei,本软件遵循 AGPLv3 许可证,附加特定的商业使用条件。此外,使用本项目还需要遵循附加条款和条件

部分代码参考自 GPT-4 和 cali.so

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

赞助版白い

个人网站 · GitHub @Innei

About

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

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 95.9%
  • CSS 2.9%
  • Other 1.2%