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 + +[](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 `./+ ็ฎไฝไธญๆ | English +
+ # ๅ ๅทๅฐ็ฑ็ฅ่ฏๅบ ## ๐ ๅ ณไบ @@ -125,3 +129,26 @@ pnpm migrate:images # ่ฟ็งปๅพ็ ## Star History [](https://star-history.com/#InvolutionHell/involutionhell.github.io&Date) + +## ่ฎธๅฏไธ็ๆ่ฏดๆ + +### ๅ ณไบ้กน็ฎไปฃ็ + +ๆฌ้กน็ฎ็**ไปฃ็ **้จๅ๏ผๆ็จไบๆๅปบๅ่ฟ่กๆฌ็ฝ็ซ็็จๅบไปฃ็ ๏ผ้ตๅพช MIT ๅผๆบๅ่ฎฎใ + +่ฟๆๅณ็ๆจๅฏไปฅ่ช็ฑๅฐไฝฟ็จใๅคๅถใไฟฎๆนใๅๅนถใๅบ็ใๅๅใๅๆๆๅ้ๅฎ่ฟไบไปฃ็ ็ๅฏๆฌ๏ผไฝๅฟ ้กปๅจๆๆๅฏๆฌๆไธป่ฆ้จๅไธญๅ ๅซๅๅง็็ๆๅฃฐๆๅ่ฎธๅฏๅฃฐๆใ + +่ฏฆๆ ่ฏท่ง [LICENSE](LICENSE) ๆไปถใ + +### ๅ ณไบๅไบซๅ ๅฎน + +ๆฌๅนณๅฐๆๅฑ็คบ/ๆถๅฝ็**ๆ็ซ ใ่ฏ่ฎบๅๅ ถไปๅฝขๅผ็ๅ ๅฎน**๏ผๅ ถ็ๆๅฝๅไฝ่ ๆๆใ + +**่ฏทๆณจๆ**๏ผ +1. ๅ ๅฎน็็ๆ**ไธ**้ตๅพช MIT ๅ่ฎฎ๏ผไป็ฑๅไฝ่ ไฟ็ใ +2. ้ค็นๆฎๅฃฐๆๆ่ทๅพๅไฝ่ ๆๆๅค๏ผ**ไปปไฝไบบไธๅพ**ๅฐ่ฟไบๅ ๅฎน็จไบๅไธ็ฎ็่ฟ่ก่ฝฌ่ฝฝใไฟฎๆน็ญไบๆฌกๅไฝใ +3. ๆฌ้กน็ฎไฝไธบๅไบซๅนณๅฐ๏ผๆ ๆณๅฏนๆๆๅ ๅฎน็ๅๅๆงใๅๆณๆง่ฟ่กไธไธๆ ธๅฎใ + +#### ็ๆไพตๆๅค็ + +ๆไปฌๅฐ้ๅนถ่ดๅไบไฟๆค็ฅ่ฏไบงๆใๅฆๆๆจ่ฎคไธบๅนณๅฐไธ็ไปปไฝๅ ๅฎนไพต็ฏไบๆจ็ๅๆณๆ็๏ผ่ฏท็ซๅณ้่ฟ **[ๆไบค Issue](https://github.com/InvolutionHell/involutionhell.github.io/issues/new)** ไธๆไปฌ่็ณปใๆไปฌๆฟ่ฏบๅจๆถๅฐ้็ฅๅนถๆ ธๅฎๆ ๅตๅ๏ผไผ่ฟ ้้ๅๅ ้คใๅฑ่ฝ็ญๅฟ ่ฆๆชๆฝใ \ No newline at end of file