Skip to content

Commit a5be1e7

Browse files
authored
Update README by removing features and scripts
1 parent 0fc17ad commit a5be1e7

File tree

1 file changed

+1
-173
lines changed

1 file changed

+1
-173
lines changed

README.md

Lines changed: 1 addition & 173 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,13 @@
44

55
这是一个基于现代 Web 技术的协作文档平台,旨在帮助学生们分享和访问学习资料。
66

7-
## ✨ 特性
8-
9-
- 🚀 **现代化技术栈**:Next.js 15 + Fumadocs + MDX
10-
- 🎨 **美观界面**:基于 Tailwind CSS 和 shadcn/ui 构建
11-
- 🌍 **双语支持**:中英文内容
12-
- 📱 **响应式设计**:完美适配所有设备
13-
-**快速且 SEO 友好**:静态生成,性能优化
14-
- 🤝 **社区驱动**:开源且协作性强
15-
167
## 🚀 快速开始
178

189
### 环境要求
1910

2011
- Node.js 18+
2112
- pnpm(推荐)
13+
- 如果您是`Windows` + `VSCode(Cursor)`, 您可能会触发`Husky`的BUG, 请使用命令行(`git commit`)的方式来进行代码提交
2214

2315
### 安装
2416

@@ -90,171 +82,7 @@ pnpm dev
9082
│ └── 📄 01-singly-linked-list.mdx
9183
```
9284

93-
## 🛠️ 可用脚本
94-
95-
```bash
96-
# 开发
97-
pnpm dev # 启动开发服务器
98-
pnpm build # 构建生产版本
99-
pnpm start # 启动生产服务器
100-
101-
# 内容
102-
103-
104-
# 导出
105-
pnpm export # 导出静态站点到 /out 目录
106-
```
10785

10886
## 📄 许可证
10987

11088
本项目采用 MIT 许可证 - 查看 [LICENSE](LICENSE) 文件了解详情。
111-
112-
## 🙏 致谢
113-
114-
- 使用 [Next.js](https://nextjs.org/) 构建
115-
-[Fumadocs](https://fumadocs.vercel.app/) 驱动
116-
- 使用 [Tailwind CSS](https://tailwindcss.com/) 样式
117-
- UI 组件来自 [shadcn/ui](https://ui.shadcn.com/)
118-
119-
特别感谢我们所有的贡献者!🎉
120-
121-
## 📞 联系我们
122-
123-
- 📧 Issues: [GitHub Issues](https://github.com/involutionhell/involutionhell.github.io/issues)
124-
- 💬 Discussions: [GitHub Discussions](https://github.com/involutionhell/involutionhell.github.io/discussions)
125-
- 🌟 Stars: 通过 ⭐ 表示支持
126-
127-
128-
# Involution Hell Docs
129-
130-
[![Deploy to GitHub Pages](https://github.com/involutionhell/involutionhell.github.io/actions/workflows/deploy.yml/badge.svg)](https://github.com/involutionhell/involutionhell.github.io/actions/workflows/deploy.yml)
131-
132-
**A modern, student-maintained knowledge base for computer science and programming.**
133-
134-
[🌐 View Live Site](https://involutionhell.github.io/) | [📖 Documentation](https://involutionhell.github.io/)
135-
136-
---
137-
138-
## 📋 About
139-
140-
This is a collaborative documentation platform built with modern web technologies, designed to help students share and access high-quality learning materials for computer science and programming.
141-
142-
## ✨ Features
143-
144-
- 🚀 **Modern Tech Stack**: Next.js 15 + Fumadocs + MDX
145-
- 🎨 **Beautiful UI**: Built with Tailwind CSS and shadcn/ui
146-
- 🌍 **Bilingual Support**: Chinese & English content
147-
- 📱 **Responsive Design**: Works perfectly on all devices
148-
-**Fast & SEO-friendly**: Static generation with optimal performance
149-
- 🤝 **Community Driven**: Open source and collaborative
150-
151-
## 🚀 Quick Start
152-
153-
### Prerequisites
154-
155-
- Node.js 18+
156-
- pnpm (recommended)
157-
158-
### Installation
159-
160-
```bash
161-
# Clone the repository
162-
git clone https://github.com/involutionhell/involutionhell.github.io.git
163-
cd involutionhell.github.io
164-
165-
# Install dependencies
166-
pnpm install
167-
168-
# Start development server
169-
pnpm dev
170-
```
171-
172-
Open [http://localhost:3000](http://localhost:3000) to see the site.
173-
174-
## 📁 Project Structure
175-
176-
```
177-
📦 involutionhell.github.io
178-
├── 📂 app/ # Next.js App Router
179-
│ ├── 📂 components/ # React Components
180-
│ ├── 📂 docs/ # Documentation Content
181-
│ │ └── 📂 computer-science/ # CS Knowledge Base
182-
│ ├── 📄 layout.tsx # Root Layout
183-
│ └── 📄 page.tsx # Homepage
184-
├── 📂 source.config.ts # Fumadocs Configuration
185-
├── 📂 tailwind.config.ts # Tailwind CSS Config
186-
└── 📄 package.json # Dependencies & Scripts
187-
```
188-
189-
## 🤝 Contributing
190-
191-
We welcome contributions from the community! Please read our [Contributing Guide](CONTRIBUTING.md) before getting started.
192-
193-
### Ways to Contribute
194-
195-
- 📝 **Content**: Add new articles or improve existing ones
196-
- 🐛 **Bug Fixes**: Report and fix issues
197-
- 🎨 **UI/UX**: Improve design and user experience
198-
- 🌐 **Translations**: Help with multilingual support
199-
- 📖 **Documentation**: Improve project documentation
200-
201-
### Quick Start for Contributors
202-
203-
1. Fork the repository
204-
2. Create a feature branch: `git checkout -b feat/your-feature`
205-
3. Make your changes
206-
4. Test your changes: `pnpm check:content`
207-
5. Submit a Pull Request
208-
209-
## 📚 Documentation Structure
210-
211-
Our content follows a hierarchical "Folder as a Book" structure:
212-
213-
```
214-
📂 docs/
215-
├── 📂 computer-science/ # Computer Science
216-
│ ├── 📄 index.mdx # CS Overview
217-
│ └── 📂 data-structures/ # Data Structures
218-
│ ├── 📄 index.mdx # DS Overview
219-
│ ├── 📂 array/ # Arrays
220-
│ │ ├── 📄 index.mdx # Array Overview
221-
│ │ ├── 📄 01-static-array.mdx
222-
│ │ └── 📄 02-dynamic-array.mdx
223-
│ └── 📂 linked-list/ # Linked Lists
224-
│ ├── 📄 index.mdx # Linked List Overview
225-
│ └── 📄 01-singly-linked-list.mdx
226-
```
227-
228-
## 🛠️ Available Scripts
229-
230-
```bash
231-
# Development
232-
pnpm dev # Start dev server
233-
pnpm build # Build for production
234-
pnpm start # Start production server
235-
236-
# Content
237-
238-
239-
# Export
240-
pnpm export # Export static site to /out
241-
```
242-
243-
## 📄 License
244-
245-
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
246-
247-
## 🙏 Acknowledgments
248-
249-
- Built with [Next.js](https://nextjs.org/)
250-
- Powered by [Fumadocs](https://fumadocs.vercel.app/)
251-
- Styled with [Tailwind CSS](https://tailwindcss.com/)
252-
- UI components from [shadcn/ui](https://ui.shadcn.com/)
253-
254-
Special thanks to all our contributors! 🎉
255-
256-
## 📞 Contact
257-
258-
- 📧 Issues: [GitHub Issues](https://github.com/involutionhell/involutionhell.github.io/issues)
259-
- 💬 Discussions: [GitHub Discussions](https://github.com/involutionhell/involutionhell.github.io/discussions)
260-
- 🌟 Stars: Show your support with a ⭐

0 commit comments

Comments
 (0)