📖 WarpNav 极速手册 (WarpNav QR)

WarpNav 极速手册 (qr.warpnav.com) 是专为开发者打造的干净、超快、无广告的代码与命令速查备忘单仓库。提供精细中文功能说明 + 纯正英文指令，支持全站离线快捷搜索。

---

🚀 本地开发与运行指南

1. 克隆仓库与安装依赖

git clone https://github.com/SatoMini/warpnav-quick-reference.git
cd warpnav-quick-reference
npm install

2. 启动本地开发服务

npm run dev

运行后在浏览器访问 http://localhost:4000 即可实时预览。

3. 构建静态产物 (Build)

npm run build

构建完成后，编译输出产物将生成在 dist/ 目录下。

---

🗂️ 项目目录结构说明

.
├── source/                 # Markdown 页面与速查卡片源码
│   ├── _posts/             # 所有速查卡片 (Python, Go, Bash, ChatGPT...)
│   ├── about/              # 关于我们页面
│   ├── notes/              # 随手笔记页面
│   └── support/            # 友情赞赏页面
├── themes/                 # 页面主题模版
│   └── coo/                # 主布局 (Header, Footer, Logo, CSS 样式)
├── scripts/                # 离线搜索与自动化构建清洗脚本
├── _config.yml             # Hexo 全局站点配置文件
├── package.json            # 依赖与打包指令
├── gulpfile.js             # HTML/JS 打包编译流程
└── .gitignore              # Git 版本控制忽略配置

---

📦 GitHub 提交与推送到远程仓库

当你需要在 GitHub 创建新仓库并上传代码时：

# 1. 初始化 Git 仓库 (如未初始化)
git init

# 2. 添加所有源文件
git add .

# 3. 提交 Commit
git commit -m "feat: initial commit for WarpNav 极速手册"

# 4. 关联 GitHub 远程仓库
git remote add origin https://github.com/SatoMini/warpnav-quick-reference.git
git branch -M main

# 5. 推送到远程仓库
git push -u origin main

提示：项目已配置标准的 .gitignore，自动排除了 node_modules/ 和临时缓存，上传时只会提交精简的源码。

---

📄 开源协议 (License)

本项目基于 GPL-3.0 License 开源。