Skip to content

Commit e813da5

Browse files
committed
fix: 转移一下README.md的重心
1 parent 8dbfe91 commit e813da5

File tree

3 files changed

+106
-184
lines changed

3 files changed

+106
-184
lines changed

CONTRIBUTING.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -114,15 +114,15 @@ cd involutionhell.github.io
114114
### 2. 安装依赖
115115

116116
```bash
117-
npm install
117+
pnpm install # 推荐;如需可改用 npm install
118118
```
119119

120120
### 3. 本地开发
121121

122122
运行开发服务器:
123123

124124
```bash
125-
npm dev
125+
pnpm dev
126126
```
127127

128128
打开浏览器访问 [http://localhost:3000](http://localhost:3000)
@@ -131,6 +131,23 @@ npm dev
131131

132132
---
133133

134+
## 🛠️ 可用脚本
135+
136+
常用脚本集中在 `package.json` 中,以下是最常用的命令:
137+
138+
```bash
139+
pnpm dev # 启动开发服务器
140+
pnpm build # 构建生产版本
141+
pnpm start # 启动生产服务器
142+
pnpm lint:images # 检查图片是否符合规范
143+
pnpm migrate:images # 自动迁移图片到对应 assets 目录
144+
pnpm postinstall # 同步必要的 Husky/Fumadocs 配置
145+
```
146+
147+
> Windows + VSCode(Cursor) 用户:如遇 Husky 在 VSCode 内置终端阻止提交,请使用外部命令行执行 `git commit`
148+
149+
---
150+
134151
## 📚 文档规范
135152

136153
所有文档放在 `docs/` 目录。

README.en.md

Lines changed: 50 additions & 101 deletions
Original file line numberDiff line numberDiff line change
@@ -8,147 +8,96 @@
88

99
[![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)
1010

11-
This is a collaborative documentation platform based on modern web technologies, designed to help students share and access learning materials.
11+
A collaborative documentation platform built with modern web technologies to help students share study notes, course materials, and project experience.
12+
13+
**Highlights**
14+
15+
- High-performance site powered by Next.js App Router and Fumadocs UI
16+
- Multi-language support with a "folder as navigation" content model
17+
- Automated deployment, image migration, and linting to reduce maintenance overhead
1218

1319
## 🚀 Quick Start
1420

15-
### Prerequisites
21+
**Prerequisites**
1622

1723
- 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.❗️
24+
- pnpm recommended (npm / yarn also work)
2125

22-
### Installation
26+
**Local preview**
2327

2428
```bash
25-
# Clone the repository
2629
git clone https://github.com/involutionhell/involutionhell.github.io.git
2730
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
3531
pnpm install
36-
37-
# Start the development server
3832
pnpm dev
3933
```
4034

41-
Open your browser and visit [http://localhost:3000](http://localhost:3000) to see the site.
35+
Visit [http://localhost:3000](http://localhost:3000) in your browser.
36+
37+
> On Windows with VSCode(Cursor) you may hit a Husky hook issue. Run `git commit` from a terminal instead.
38+
39+
Looking for additional scripts, debugging tips, or contribution workflows? Check out [CONTRIBUTING.md](CONTRIBUTING.md).
4240

43-
## 📁 Project Structure
41+
## 📁 Directory Overview
4442

4543
```
4644
📦 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
45+
├── 📂 app/ # Next.js App Router
46+
│ ├── 📂 components/ # UI components
47+
│ ├── 📂 docs/ # Content (folder-as-a-book)
48+
│ └── 📄 layout.tsx # Root layout
49+
├── 📄 source.config.ts # Fumadocs configuration
50+
├── 📄 tailwind.config.ts
51+
└── 📄 package.json
5652
```
5753

58-
## 🤝 Contributing
54+
Documentation follows a layered "Folder as a Book" structure. Naming rules, required frontmatter, and authoring tips live in the contribution guide.
5955

60-
We welcome community contributions! Before you start, please read our [Contribution Guide](CONTRIBUTING.md).
56+
## 🤝 Contribute Together
6157

62-
### How to Contribute
58+
Community contributions are always welcome:
6359

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
60+
- Content & translations
61+
- Bug fixes and tooling improvements
62+
- UI / UX design and implementation
63+
- Documentation and workflow enhancements
6964

70-
### Quick Start for Contributors
65+
For the full workflow, PR checklist, and UI collaboration guidelines, see [CONTRIBUTING.md](CONTRIBUTING.md).
7166

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
67+
## 🖼️ Documentation & Assets
7768

78-
## 📚 Documentation Structure
69+
The repo ships with automated image migration and linting. Learn how to place assets, reference images, and structure frontmatter in:
7970

80-
Our content uses a hierarchical "Folder as a Book" structure:
71+
- [Documentation guidelines & asset rules](CONTRIBUTING.md#-文档规范)
72+
- [Available scripts & automation](CONTRIBUTING.md#-可用脚本)
8173

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-
```
74+
## 🙏 Special Thanks
9675

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!
76+
Thanks to Shanghai AI Lab for providing computing support!
12277

12378
![](./public/shanghaiailab.png)
12479

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)
80+
- [InternS1 Project](https://github.com/InternLM/Intern-S1/tree/main)
81+
- [InternStudio Platform](https://studio.intern-ai.org.cn/console/dashboard)
82+
- [Puyu API Docs](https://internlm.intern-ai.org.cn/api/document)
12883

129-
## Star History
84+
## ⭐️ Star History
13085

13186
[![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)
13287

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.
88+
## 📜 License & Copyright
13889

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.
90+
The project code is released under the [MIT License](LICENSE).
14091

141-
For details, see the [LICENSE](LICENSE) file.
92+
### Codebase
14293

143-
### About Shared Content
94+
The **code** (i.e., the software powering this site) is licensed under MIT: you may use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the software as long as the original copyright notice and permission notice are included. See [LICENSE](LICENSE) for details.
14495

145-
The copyright of **articles, comments, and other forms of content** displayed/collected on this platform belongs to the original authors.
96+
### Shared Content
14697

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.
98+
The copyright of **articles, comments, and other contributed content** remains with the original authors:
15199

152-
#### Copyright Infringement Handling
100+
1. The content is **not** covered by the MIT License; commercial reuse or derivative works require permission.
101+
2. We cannot individually verify every submission for originality or legality.
153102

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.
103+
If your rights are infringed, please **[open an issue](https://github.com/InvolutionHell/involutionhell.github.io/issues/new)**. We will review and take appropriate action (removal, blocking, etc.) promptly.

0 commit comments

Comments
 (0)