rand777 f427e2f185 docs: update README-en.md

2025-03-07 23:47:04 +08:00

4.5 KiB

Raw Permalink Blame History

🌍 PGuide Docs - Cultivating a Knowledge Garden Together

In this interconnected era, knowledge flows like stardust across the cosmos. Every page in this project embodies the collective wisdom of our community. We invite you to join hands in nurturing this ever-growing knowledge tree that belongs to all contributors. 🌱

🌟 Golden Rule

"When you discover constellations in our documentation, light a path for future travelers" — Every patch you contribute becomes a stepping stone toward a better open-source world.

🛠️ Developer's Toolkit

Core Infrastructure

Node.js v18.20.0+ (Recommend using Node Version Manager)
Package Manager: pnpm 8+ or Yarn 2+ (Modern package management required)

Recommended Gear

🛡️ Environment Guardian: nvm-windows
🖥️ Code Forge: WebStorm / VSCode (With Vue ecosystem plugins)

📂 Codex Structure

PGuide-Docs/
├── docs/                    # Chronicle Scrolls (Content Repository)
└── .vuepress/              # Magic Workshop
    ├── public/             # Treasure Chest (Static Assets)
    ├── theme/              # Castle Blueprints (Theme Configuration)
    ├── client.ts          # Portal Keeper (Client Options)
    ├── config.ts          # Grand Encyclopedia (Global Config)
    ├── navbar.ts          # Signposts (Navigation Setup)
    ├── notes.ts           # Treasure Map (Document Structure)
    └── plume.config.ts    # Palette (Theme Styling)

🚀 Quickstart Guide

🏗️ Setup Foundations

# Newcomers should install nvm first
nvm install lts

# Configure Mirror Sources (Choose your express lane):
nvm node_mirror https://mirrors.cernet.edu.cn/nodejs-release/  # Campus Network
nvm node_mirror https://mirrors.aliyun.com/nodejs-release/     # Alibaba Cloud Express

# Equip Modern Toolchain
npm install -g pnpm  # Faster npm alternative
pnpm i              # Install arcane ingredients
pnpm run docs:dev   # Open local preview portal

✨ Hot-Reload Tips

After modifying navigation config, remember to Ctrl+C and restart the server. Wait for "VuePress dev server listening" message to confirm portal activation.

🌉 Contribution Workflow

Code Subway Protocol

Create local branch dev/[your-name]
When ready to commit:
- Ctrl+Shift+K to summon commit magic
- Recommended message format (Following Angular Commit Convention):
```
docs: Add stargazing navigation to README
fix: Resolve 404 wormhole issue
feat: Implement cosmic hyperlink module
```
Visit Github Station and click "New pull request"

🧭 Pitfall Survival Guide

Resource Plane Rules

🎨 Store vector graphics in /public/* (Reference directly: /AI.svg)
📹 Video resources in src/video, usage example:
```

```
🔍 Encountering errors? Try this reboot spell:
```
pnpm update && pnpm upgrade
```

Arcane Markdown Recipes

<!-- Pixpin Snapshot Magic -->
![Configuration Demo 1](public/src/stellar-config-1.png)
![Configuration Demo 2](public/src/stellar-config-2.png)
*Press F2 to archive cosmic screenshots*

🆘 FAQ Compendium

Git Push Failed? (SSL Error)

🌐 Check your Stellar Communicator (Clash Proxy) settings

🛠️ Configure Git Express Lane:

git config --global http.proxy http://127.0.0.1:7890
git config --global https.proxy http://127.0.0.1:7890

🚀 Try SSH Warp Drive:

git clone git@github.com:MultipledMe/PGuide-Docs.git

🧐 Truth Gate Malfunction?

Don't panic when seeing Giscus CORS errors – these are just mischievous cross-origin sprites that won't affect our documentation castle:

🌌 Starlight Forum

"We're not just writing code – we're weaving the web that connects worlds" — Anticipating your first contribution! For uncharted territories, launch signal flares in our Issues section.

Translated with preservation of original metaphors and technical accuracy

4.5 KiB Raw Permalink Blame History Unescape Escape