diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000..4e87516 --- /dev/null +++ b/README.en.md @@ -0,0 +1,154 @@ +

+ 简体中文 | English +

+ +# Involution Hell Knowledge Base + +## 📋 About + +[![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) + +This is a collaborative documentation platform based on modern web technologies, designed to help students share and access learning materials. + +## 🚀 Quick Start + +### Prerequisites + +- Node.js 18+ +- pnpm (recommended) + +### ❗️If you are using `Windows` + `VSCode(Cursor)`, you may encounter a `Husky` bug. Please use the command line (`git commit`) to commit your code.❗️ + +### Installation + +```bash +# Clone the repository +git clone https://github.com/involutionhell/involutionhell.github.io.git +cd involutionhell.github.io + +If you don't have pnpm installed yet, you can run: + +# Install pnpm globally +npm install -g pnpm + +# Install dependencies +pnpm install + +# Start the development server +pnpm dev +``` + +Open your browser and visit [http://localhost:3000](http://localhost:3000) to see the site. + +## 📁 Project Structure + +``` +📦 involutionhell.github.io +├── 📂 app/ # Next.js App Router +│ ├── 📂 components/ # React components +│ ├── 📂 docs/ # Document content +│ │ └── 📂 ai/ # AI knowledge base +│ ├── 📄 layout.tsx # Root layout +│ └── 📄 page.tsx # Home page +├── 📂 source.config.ts # Fumadocs configuration +├── 📂 tailwind.config.ts # Tailwind CSS configuration +└── 📄 package.json # Dependencies and scripts +``` + +## 🤝 Contributing + +We welcome community contributions! Before you start, please read our [Contribution Guide](CONTRIBUTING.md). + +### How to Contribute + +- 📝 **Content**: Add new articles or improve existing ones +- 🐛 **Bug Fixes**: Report and fix issues +- 🎨 **UI/UX**: Improve design and user experience +- 🌐 **Translation**: Help with multi-language support +- 📖 **Documentation**: Improve project documentation + +### Quick Start for Contributors + +1. Fork this repository +2. Create a feature branch: `git checkout -b feat/your-feature` +3. Make your changes +4. Test your changes: `pnpm check:content` +5. Submit a PR + +## 📚 Documentation Structure + +Our content uses a hierarchical "Folder as a Book" structure: + +``` +📂 docs/ +├── 📂 computer-science/ # Computer Science +│ ├── 📄 index.mdx # Computer Science Overview +│ └── 📂 data-structures/ # Data Structures +│ ├── 📄 index.mdx # Data Structures Overview +│ ├── 📂 array/ # Array +│ │ ├── 📄 index.mdx # Array Overview +│ │ ├── 📄 01-static-array.mdx +│ │ └── 📄 02-dynamic-array.mdx +│ └── 📂 linked-list/ # Linked List +│ ├── 📄 index.mdx # Linked List Overview +│ └── 📄 01-singly-linked-list.mdx +``` + +## 🛠️ Available Scripts + +```bash +# Development +pnpm dev # Start the development server +pnpm build # Build for production +pnpm start # Start the production server +pnpm postinstall +pnpm lint:images # Check if images follow the rules +pnpm migrate:images # Migrate images +``` + +## Image Management Guidelines (Brief) + +An automated script will move the images you reference to the same directory as the MDX file, following these rules: + +- **Storage**: In `./.assets/` in the same directory as the MDX file. + - Example: `foo.mdx` → `./foo.assets/.png`; `index.mdx` → `./index.assets/.png`. +- **Reference**: Relative path `![](./.assets/.png)`. +- **Automation**: Automatically migrates and changes references on commit; Image Lint only warns and does not block commits. +- **Sharing**: Use `/images/site/*` for site-level images, `/images/components//*` for component demos; images shared by multiple documents can be kept in `/images/...`. + +## Special Thanks + +### Thanks to Shanghai AI Lab for providing computing power support for this project! + +![](./public/shanghaiailab.png) + +- [InternS1 Project Address](https://github.com/InternLM/Intern-S1/tree/main) +- [InternStudio Computing Power Platform](https://studio.intern-ai.org.cn/console/dashboard) +- [Puyu API Documentation](https://internlm.intern-ai.org.cn/api/document) + +## Star History + +[![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) + +## License and Copyright Notice + +### About the Project Code + +The **code** part of this project (referring to the program code used to build and run this website) is licensed under the MIT License. + +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. + +For details, see the [LICENSE](LICENSE) file. + +### About Shared Content + +The copyright of **articles, comments, and other forms of content** displayed/collected on this platform belongs to the original authors. + +**Please note**: +1. The copyright of the content does **not** follow the MIT license and is still retained by the original author. +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. +3. As a sharing platform, this project cannot verify the originality and legality of all content one by one. + +#### Copyright Infringement Handling + +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. diff --git a/README.md b/README.md index 0016cbe..49261c2 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,7 @@ +

+ 简体中文 | English +

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