Quick Reference 速查表使用手册:210 份清单的定位、构建与部署一览
【免费下载链接】reference面向开发者的技术速查清单(Cheat Sheets)集合,整理常见技术、工具与开发流程,帮助快速查阅关键信息,提高开发效率。项目地址: https://gitcode.com/GitHub_Trending/referen/reference
Quick Reference(reference 仓库)把开发中反复查的命令、端口、快捷键整理成 200 余份 Markdown 速查表,翻到即用。本文按"查"组织:先用一张总表定位该打开哪个文件,再列构建、部署与新增清单时要核对的默认值和命令。
按问题定位:常用清单对照表
docs/下每张清单对应一类问题,先按左列找到你的场景,再打开对应文件:
| 你手头的问题 | 先打开 | 同组常一起查 | 清单里有什么 |
|---|---|---|---|
| 记不住 Linux 命令参数 | docs/bash.md | docs/grep.md、docs/sed.md、docs/find.md | shell 常用命令与管道写法 |
| Git 提交与协作 | docs/git.md | docs/github-cli.md、docs/github-actions.md | 分支、暂存区、rebase 操作 |
| 数据库连接与查询 | docs/mysql.md | docs/postgres.md、docs/redis.md、docs/mongodb.md | 连接参数、常用 SQL 与索引 |
| 前端语法忘了 | docs/javascript.md | docs/typescript.md、docs/react.md、docs/vue.md | 语言核心语法与框架 API |
| 端口号、状态码含义 | docs/ports.md | docs/http-status-code.md、docs/mime.md | 端口对照表与协议说明 |
| 正则表达式写法 | docs/regex.md | docs/xpath.md | 匹配模式与反例 |
| Docker 部署 | docs/docker.md | docs/dockerfile.md、docs/docker-compose.md | 镜像、容器、编排命令 |
| Node 包管理 | docs/npm.md | docs/pnpm.md、docs/package.json.md | 安装、脚本与依赖字段 |
| Python 环境与框架 | docs/python.md | docs/pip.md、docs/django.md、docs/fastapi.md | 语法、虚拟环境与路由 |
| 配置文件格式 | docs/json.md | docs/yaml.md、docs/toml.md、docs/ini.md | 语法差异与缩进规则 |
| 快捷键忘了 | docs/vscode.md | docs/intelli-j-idea.md、docs/google-chrome.md | IDE 与浏览器按键 |
| AI 命令行工具 | docs/ai-tools.md | docs/claude.md、docs/gemini-cli.md | 各 CLI 的安装与常用参数 |
跑通构建:5 个默认值先记牢
整个站点就是 refs-cli 把docs/下的 Markdown 编译成静态 HTML,构建与部署相关的默认值集中在以下 5 项:
- 构建命令
npm run build:一次性编译全部清单,静态产物输出到根目录dist/。 - 监听命令
npm run start:等价于带--watch的编译,docs/下改动即时重新生成 HTML。 - Node 版本要求
>=16:写在 package.json 的 engines 字段,低版本装依赖会直接报错。 - Docker 基础镜像:
wcjiang/docker-static-website:latest,镜像内无构建步骤,只复制dist目录。 - Netlify 参数:build 命令为
npm run build、发布目录为dist,netlify.toml 已配好。
新增一份清单:3 处内容要同步改
加一张新清单涉及清单文件、首页导航、首页图标三处,漏一处就会出现有页无入口或导航丢图标:
- 清单文件
docs/xxx.md:首行 h1 作页面大标题,紧接一段介绍文字;h2 是分类、h3 是卡片。 - 首页导航(根目录 README.md):在对应分组的
<!--rehype:class=home-card-->注释前加一行链接,导航随编译自动生成。 - 首页图标
assets/xxx.svg:文件名与清单同名,大小写敏感。 - SVG 规格
1em × 1em:尺寸height="1em" width="1em",颜色fill="currentColor"跟随导航文字色。 - 样式注释
<!--rehype:style=...-->:行尾注释控制卡片背景色与角标,仅官方编译链生效。
默认值与易错点
dist/是构建产物而非仓库内容:Dockerfile 只有一行COPY ./dist .,本地没先跑npm run build时打包镜像会直接失败。- 页面标题取自 h1 而非文件名:h1 用
===下划线写法,docs/ports.md的标题是"常用端口 备忘清单",重命名文件不影响页面标题。 - 图标与清单名大小写敏感:
vue.md对应vue.svg,任一侧大小写不一致就丢图标。 - rehype 注释依赖官方编译链:把 .md 直接丢给其他 Markdown 渲染器,行尾
<!--rehype:...-->注释全部失效,卡片样式丢失。
交付前过一遍
- 在
docs/目录按文件名搜一遍,确认新清单没有重名 - 本地跑一次
npm run build,打开dist/index.html核对新页面与图标 - 改清单文件名时,同步改
assets/下 SVG 与 README.md 中的链接路径 - 打镜像前确认
dist/已生成,镜像里不含 Node 构建环境 - 发布前过一遍首页导航,确认分组、颜色注释与贡献标记齐全
速查表的价值在"翻到就能查":先按总表定位文件,再按上面的默认值核对一遍即可。想继续补内容或查排版语法,读 CONTRIBUTING.md 与 docs/quickreference.md。
【免费下载链接】reference面向开发者的技术速查清单(Cheat Sheets)集合,整理常见技术、工具与开发流程,帮助快速查阅关键信息,提高开发效率。项目地址: https://gitcode.com/GitHub_Trending/referen/reference
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考