Skip to content

0dysseus7/involutionhell.github.io

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

简体中文 | English

内卷地狱知识库

📋 关于

zread

这是一个基于现代 Web 技术的协作文档平台,帮助学生分享和获取学习资料、课程笔记和项目经验。

平台亮点

  • Next.js App Router + Fumadocs UI 打造的高性能站点
  • 支持多语言与“文件即导航”的目录结构
  • 自动化部署、图片迁移和内容校验,降低维护成本

🚀 快速开始

环境要求

  • Node.js 18+
  • 推荐使用 pnpm(也兼容 npm / yarn)

❗️如果您是Windows + VSCode(Cursor), 您可能会触发Husky的BUG, 请使用命令行(git commit)的方式来进行代码提交❗️

安装

# 克隆仓库
git clone https://github.com/involutionhell/involutionhell.github.io.git
cd involutionhell.github.io

如果你的电脑还没有安装 pnpm,可以先运行:

# 全局安装 pnpm
npm install -g pnpm

# 安装依赖
pnpm install
pnpm dev

打开浏览器访问 http://localhost:3000

Windows + VSCode(Cursor) 可能触发 Husky 提交钩子问题,建议直接使用命令行执行 git commit

更多安装脚本、调试命令与常见问题,请查看 CONTRIBUTING.md

📁 目录概览

📦 involutionhell.github.io
├── 📂 app/              # Next.js App Router
│   ├── 📂 components/   # UI 组件
│   ├── 📂 docs/         # 文档内容(Folder as a Book)
│   └── 📄 layout.tsx    # 根布局
├── 📄 source.config.ts  # Fumadocs 配置
├── 📄 tailwind.config.ts
└── 📄 package.json

站内文档采用分层式“Folder as a Book”结构。命名规范、Frontmatter 要求等写作细则详见贡献指南。

🤝 一起贡献

我们欢迎来自社区的任何形式的改进与补充:

  • 内容与翻译
  • Bug 修复与脚本优化
  • UI / UX 设计与实现
  • 文档与流程完善

完整流程、PR 检查与 UI 协作约定请参考 CONTRIBUTING.md

🖼️ 文档与资产

仓库提供自动化图片迁移与 Lint 规则。如何放置图片、引用资产、撰写 Frontmatter 等细节已在贡献指南中整理:

🙏 特别鸣谢

感谢上海 AI Lab 书生大模型对本项目的算力支持!

⭐️ Star History

Star History Chart

📜 协议与版权

本项目代码遵循 MIT License 开源。

关于项目代码

本项目的代码部分(指用于构建和运行本网站的程序代码)遵循 MIT 开源协议。

这意味着您可以自由地使用、复制、修改、合并、出版、分发、再授权及销售这些代码的副本,但必须在所有副本或主要部分中包含原始的版权声明和许可声明。

详情请见 LICENSE 文件。

关于分享内容

本平台所展示/收录的文章、评论及其他形式的内容,其版权归原作者所有。

请注意

  1. 内容的版权遵循 MIT 协议,仍由原作者保留。
  2. 除特殊声明或获得原作者授权外,任何人不得将这些内容用于商业目的进行转载、修改等二次创作。
  3. 本项目作为分享平台,无法对所有内容的原创性、合法性进行一一核实。

版权侵权处理

我们尊重并致力于保护知识产权。如果您认为平台上的任何内容侵犯了您的合法权益,请立即通过 提交 Issue 与我们联系。我们承诺在收到通知并核实情况后,会迅速采取删除、屏蔽等必要措施。

About

A website of study resource, full-open-source

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • MDX 56.8%
  • TypeScript 36.3%
  • JavaScript 3.8%
  • CSS 3.1%