Skip to content

Commit 8dbfe91

Browse files
Mira190Mira190
authored
Merge pull request #128 from Mira190/pr-127
Pr 127
2 parents 15d5e08 + bf64d6c commit 8dbfe91

File tree

2 files changed

+181
-1
lines changed

2 files changed

+181
-1
lines changed

‎README.en.md‎

Lines changed: 154 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,154 @@
1+
<p align="right">
2+
<a href="./README.md">简体中文</a> | <a href="./README.en.md">English</a>
3+
</p>
4+
5+
# Involution Hell Knowledge Base
6+
7+
## 📋 About
8+
9+
[![zread](https://img.shields.io/badge/Ask_Zread-_.svg?style=flat&color=00b0aa&labelColor=000000&logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB3aWR0aD0iMTYiIGhlaWdodD0iMTYiIHZpZXdCb3g9IjAgMCAxNiAxNiIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KPHBhdGggZD0iTTQuOTYxNTYgMS42MDAxSDIuMjQxNTZDMS44ODgxIDEuNjAwMSAxLjYwMTU2IDEuODg2NjQgMS42MDE1NiAyLjI0MDFWNC45NjAxQzEuNjAxNTYgNS4zMTM1NiAxLjg4ODEgNS42MDAxIDIuMjQxNTYgNS42MDAxSDQuOTYxNTZDNS4zMTUwMiA1LjYwMDEgNS42MDE1NiA1LjMxMzU2IDUuNjAxNTYgNC45NjAxVjIuMjQwMUM1LjYwMTU2IDEuODg2NjQgNS4zMTUwMiAxLjYwMDEgNC45NjE1NiAxLjYwMDFaIiBmaWxsPSIjZmZmIi8%2BCjxwYXRoIGQ9Ik00Ljk2MTU2IDEwLjM5OTlIMi4yNDE1NkMxLjg4ODEgMTAuMzk5OSAxLjYwMTU2IDEwLjY4NjQgMS42MDE1NiAxMS4wMzk5VjEzLjc1OTlDMS42MDE1NiAxNC4xMTM0IDEuODg4MSAxNC4zOTk5IDIuMjQxNTYgMTQuMzk5OUg0Ljk2MTU2QzUuMzE1MDIgMTQuMzk5OSA1LjYwMTU2IDE0LjExMzQgNS42MDE1NiAxMy43NTk5VjExLjAzOTlDNS42MDE1NiAxMC42ODY0IDUuMzE1MDIgMTAuMzk5OSA0Ljk2MTU2IDEwLjM5OTlaIiBmaWxsPSIjZmZmIi8%2BCjxwYXRoIGQ9Ik0xMy43NTg0IDEuNjAwMUgxMS4wMzg0QzEwLjY4NSAxLjYwMDEgMTAuMzk4NCAxLjg4NjY0IDEwLjM5ODQgMi4yNDAxVjQuOTYwMUMxMC4zOTg0IDUuMzEzNTYgMTAuNjg1IDUuNjAwMSAxMS4wMzg0IDUuNjAwMUgxMy43NTg0QzE0LjExMTkgNS42MDAxIDE0LjM5ODQgNS4zMTM1NiAxNC4zOTg0IDQuOTYwMVYyLjI0MDFDMTQuMzk4NCAxLjg4NjY0IDE0LjExMTkgMS42MDAxIDEzLjc1ODQgMS42MDAxWiIgZmlsbD0iI2ZmZiIvPgo8cGF0aCBkPSJNNCAxMkwxMiA0TDQgMTJaIiBmaWxsPSIjZmZmIi8%2BCjxwYXRoIGQ9Ik00IDEyTDEyIDQiIHN0cm9rZT0iI2ZmZiIgc3Ryb2tlLXdpZHRoPSIxLjUiIHN0cm9rZS1saW5lY2FwPSJyb3VuZCIvPgo8L3N2Zz4K&logoColor=ffffff)](https://zread.ai/InvolutionHell/involutionhell.github.io)
10+
11+
This is a collaborative documentation platform based on modern web technologies, designed to help students share and access learning materials.
12+
13+
## 🚀 Quick Start
14+
15+
### Prerequisites
16+
17+
- Node.js 18+
18+
- pnpm (recommended)
19+
20+
### ❗️If you are using `Windows` + `VSCode(Cursor)`, you may encounter a `Husky` bug. Please use the command line (`git commit`) to commit your code.❗️
21+
22+
### Installation
23+
24+
```bash
25+
# Clone the repository
26+
git clone https://github.com/involutionhell/involutionhell.github.io.git
27+
cd involutionhell.github.io
28+
29+
If you don't have pnpm installed yet, you can run:
30+
31+
# Install pnpm globally
32+
npm install -g pnpm
33+
34+
# Install dependencies
35+
pnpm install
36+
37+
# Start the development server
38+
pnpm dev
39+
```
40+
41+
Open your browser and visit [http://localhost:3000](http://localhost:3000) to see the site.
42+
43+
## 📁 Project Structure
44+
45+
```
46+
📦 involutionhell.github.io
47+
├── 📂 app/ # Next.js App Router
48+
│ ├── 📂 components/ # React components
49+
│ ├── 📂 docs/ # Document content
50+
│ │ └── 📂 ai/ # AI knowledge base
51+
│ ├── 📄 layout.tsx # Root layout
52+
│ └── 📄 page.tsx # Home page
53+
├── 📂 source.config.ts # Fumadocs configuration
54+
├── 📂 tailwind.config.ts # Tailwind CSS configuration
55+
└── 📄 package.json # Dependencies and scripts
56+
```
57+
58+
## 🤝 Contributing
59+
60+
We welcome community contributions! Before you start, please read our [Contribution Guide](CONTRIBUTING.md).
61+
62+
### How to Contribute
63+
64+
- 📝 **Content**: Add new articles or improve existing ones
65+
- 🐛 **Bug Fixes**: Report and fix issues
66+
- 🎨 **UI/UX**: Improve design and user experience
67+
- 🌐 **Translation**: Help with multi-language support
68+
- 📖 **Documentation**: Improve project documentation
69+
70+
### Quick Start for Contributors
71+
72+
1. Fork this repository
73+
2. Create a feature branch: `git checkout -b feat/your-feature`
74+
3. Make your changes
75+
4. Test your changes: `pnpm check:content`
76+
5. Submit a PR
77+
78+
## 📚 Documentation Structure
79+
80+
Our content uses a hierarchical "Folder as a Book" structure:
81+
82+
```
83+
📂 docs/
84+
├── 📂 computer-science/ # Computer Science
85+
│ ├── 📄 index.mdx # Computer Science Overview
86+
│ └── 📂 data-structures/ # Data Structures
87+
│ ├── 📄 index.mdx # Data Structures Overview
88+
│ ├── 📂 array/ # Array
89+
│ │ ├── 📄 index.mdx # Array Overview
90+
│ │ ├── 📄 01-static-array.mdx
91+
│ │ └── 📄 02-dynamic-array.mdx
92+
│ └── 📂 linked-list/ # Linked List
93+
│ ├── 📄 index.mdx # Linked List Overview
94+
│ └── 📄 01-singly-linked-list.mdx
95+
```
96+
97+
## 🛠️ Available Scripts
98+
99+
```bash
100+
# Development
101+
pnpm dev # Start the development server
102+
pnpm build # Build for production
103+
pnpm start # Start the production server
104+
pnpm postinstall
105+
pnpm lint:images # Check if images follow the rules
106+
pnpm migrate:images # Migrate images
107+
```
108+
109+
## Image Management Guidelines (Brief)
110+
111+
An automated script will move the images you reference to the same directory as the MDX file, following these rules:
112+
113+
- **Storage**: In `./<basename>.assets/` in the same directory as the MDX file.
114+
- Example: `foo.mdx` → `./foo.assets/<img>.png`; `index.mdx` → `./index.assets/<img>.png`.
115+
- **Reference**: Relative path `![](./<basename>.assets/<img>.png)`.
116+
- **Automation**: Automatically migrates and changes references on commit; Image Lint only warns and does not block commits.
117+
- **Sharing**: Use `/images/site/*` for site-level images, `/images/components/<name>/*` for component demos; images shared by multiple documents can be kept in `/images/...`.
118+
119+
## Special Thanks
120+
121+
### Thanks to Shanghai AI Lab for providing computing power support for this project!
122+
123+
![](./public/shanghaiailab.png)
124+
125+
- [InternS1 Project Address](https://github.com/InternLM/Intern-S1/tree/main)
126+
- [InternStudio Computing Power Platform](https://studio.intern-ai.org.cn/console/dashboard)
127+
- [Puyu API Documentation](https://internlm.intern-ai.org.cn/api/document)
128+
129+
## Star History
130+
131+
[![Star History Chart](https://api.star-history.com/svg?repos=InvolutionHell/involutionhell.github.io&type=Date)](https://star-history.com/#InvolutionHell/involutionhell.github.io&Date)
132+
133+
## License and Copyright Notice
134+
135+
### About the Project Code
136+
137+
The **code** part of this project (referring to the program code used to build and run this website) is licensed under the MIT License.
138+
139+
This means you are free to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the code, but you must include the original copyright notice and license statement in all copies or substantial portions of the software.
140+
141+
For details, see the [LICENSE](LICENSE) file.
142+
143+
### About Shared Content
144+
145+
The copyright of **articles, comments, and other forms of content** displayed/collected on this platform belongs to the original authors.
146+
147+
**Please note**:
148+
1. The copyright of the content does **not** follow the MIT license and is still retained by the original author.
149+
2. Unless otherwise stated or authorized by the original author, **no one may** use this content for commercial purposes, such as reprinting, modification, and other secondary creations.
150+
3. As a sharing platform, this project cannot verify the originality and legality of all content one by one.
151+
152+
#### Copyright Infringement Handling
153+
154+
We respect and are committed to protecting intellectual property. If you believe that any content on the platform infringes your legal rights, please contact us immediately by **[submitting an Issue](https://github.com/InvolutionHell/involutionhell.github.io/issues/new)**. We promise to take necessary measures such as deletion and blocking promptly after receiving the notification and verifying the situation.

‎README.md‎

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
<p align="right">
2+
<a href="./README.md">简体中文</a> | <a href="./README.en.md">English</a>
3+
</p>
4+
15
# 内卷地狱知识库
26

37
## 📋 关于
@@ -132,9 +136,31 @@ pnpm migrate:images # 迁移图片
132136

133137
本项目代码遵循 [MIT License](LICENSE) 开源。
134138

135-
请注意：
139+
### 版权声明总纲
136140

137141
- **MIT 协议仅适用于代码部分**。
138142
- 本仓库中分享的文章、文档等内容版权归原作者所有。
139143
- 我们无法认证分享者是否为该文章的创作者。
140144
- 若您的版权受到侵害，请随时联系我们，我们将及时处理。
145+
146+
### 关于项目代码
147+
148+
本项目的**代码**部分（指用于构建和运行本网站的程序代码）遵循 MIT 开源协议。
149+
150+
这意味着您可以自由地使用、复制、修改、合并、出版、分发、再授权及销售这些代码的副本，但必须在所有副本或主要部分中包含原始的版权声明和许可声明。
151+
152+
详情请见 [LICENSE](LICENSE) 文件。
153+
154+
### 关于分享内容
155+
156+
本平台所展示/收录的**文章、评论及其他形式的内容**，其版权归原作者所有。
157+
158+
**请注意**：
159+
160+
1. 内容的版权**不**遵循 MIT 协议，仍由原作者保留。
161+
2. 除特殊声明或获得原作者授权外，**任何人不得**将这些内容用于商业目的进行转载、修改等二次创作。
162+
3. 本项目作为分享平台，无法对所有内容的原创性、合法性进行一一核实。
163+
164+
### 版权侵权处理
165+
166+
我们尊重并致力于保护知识产权。如果您认为平台上的任何内容侵犯了您的合法权益，请立即通过 **[提交 Issue](https://github.com/InvolutionHell/involutionhell.github.io/issues/new)** 与我们联系。我们承诺在收到通知并核实情况后，会迅速采取删除、屏蔽等必要措施。

0 commit comments

Comments
 (0)