Skip to content

README.en.md

Latest commit

 

History

History
151 lines (101 loc) · 8.07 KB

README.en.md

File metadata and controls

151 lines (101 loc) · 8.07 KB
Raw

简体中文 | English

Involution Hell Logo

Typing SVG

Next.js Vercel Official Website

📋 About

zread

A collaborative documentation platform built with modern web technologies to help students share study notes, course materials, and project experience.

Highlights

  • High-performance site powered by Next.js App Router and Fumadocs UI
  • Multi-language support with a "folder as navigation" content model
  • Automated deployment, image migration, and linting to reduce maintenance overhead

🚀 Quick Start

Prerequisites

  • Node.js 18+
  • pnpm 10.20.0 (locked version - see installation instructions below)

Local preview

git clone https://github.com/involutionhell/involutionhell.git
cd involutionhell

# Recommended: Use corepack (comes with Node.js 16.9+)
corepack enable

# Or install the specific pnpm version globally
npm install -g pnpm@10.20.0

# Install dependencies
pnpm install

# Start dev server
pnpm dev

⚠️ Important: This project locks pnpm to version 10.20.0 in package.json. Please use the same version to avoid pnpm-lock.yaml format inconsistencies. Check your version with pnpm --version or run pnpm check:pnpm-version to verify.

Visit http://localhost:3000 in your browser.

On Windows with VSCode(Cursor) you may hit a Husky hook issue. Run git commit from a terminal instead.

Looking for additional scripts, debugging tips, or contribution workflows? Check out CONTRIBUTING.md.

📁 Directory Overview

📦 involutionhell
├── 📂 app/              # Next.js App Router
│   ├── 📂 components/   # UI components
│   ├── 📂 docs/         # Content (folder-as-a-book)
│   └── 📄 layout.tsx    # Root layout
├── 📄 source.config.ts  # Fumadocs configuration
├── 📄 tailwind.config.ts
└── 📄 package.json

Documentation follows a layered "Folder as a Book" structure. Naming rules, required frontmatter, and authoring tips live in the contribution guide.

🤝 Contribute Together

Community contributions are always welcome:

  • Content & translations
  • Bug fixes and tooling improvements
  • UI / UX design and implementation
  • Documentation and workflow enhancements

For the full workflow, PR checklist, and UI collaboration guidelines, see CONTRIBUTING.md.

Contributors

🖼️ Documentation & Assets

The repo ships with automated image migration and linting. Learn how to place assets, reference images, and structure frontmatter in:

🙏 Special Thanks

Thanks to Shanghai AI Lab for providing computing support!

⭐️ Star History

Star History Chart

📜 License & Copyright

This project is dual-licensed — code and content are licensed separately.

Part License File
Code (the software powering the site: app/, lib/, components, scripts, config) Apache License 2.0 LICENSE
Content (articles/docs under content/docs/) CC BY-NC-SA 4.0 LICENSE-CONTENT

Codebase (Apache-2.0)

The software that builds and runs this site is open source under the Apache License 2.0 — use, modify, and redistribute freely (including commercially), keeping the copyright and NOTICE.

Documentation content (CC BY-NC-SA 4.0)

The articles and docs under content/docs/ are licensed under CC BY-NC-SA 4.0: share and adapt for non-commercial purposes with attribution, distributing derivatives under the same license. Commercial use requires separate permission.

Shared Content

The copyright of articles, comments, and other contributed content remains with the original authors and contributors:

  1. Unless otherwise noted by the original author, contributed content defaults to the same CC BY-NC-SA 4.0 terms above.
  2. Commercial reuse or derivative works still require explicit permission from the author.
  3. We cannot individually verify every submission for originality or legality.

If your rights are infringed, please open an issue. We will review and take appropriate action (removal, blocking, etc.) promptly.