全部文章

GitHub 使用技巧

GitHub 搜索语法、快捷键、Profile README、Gist 与实用功能

目录 17 节

GitHub 使用技巧

这页适合当作“GitHub 日常协作效率手册”来用。很多人只把 GitHub 当仓库托管平台,但真正高频的效率提升,往往来自搜索、永久链接、PR 协作、通知治理和 CLI 自动化。

推荐使用顺序

如果你是第一次系统整理 GitHub 使用方式,建议按下面顺序掌握:

  1. 先学会搜索语法和仓库内快捷跳转
  2. 再掌握 PR、Issue、Blame、永久链接这些协作功能
  3. 然后接入 gh CLI 提升命令行效率
  4. 最后再补 Profile README、Pages、Gist 等个人展示能力

搜索语法

# 按语言
language:typescript stars:>1000

# 按文件内容
"useEffect" language:tsx

# 按仓库
repo:vuejs/core "defineComponent"

# 按路径
path:src/utils filename:helper

# 按大小
size:>1000 language:go

# 按日期
created:>2025-01-01 stars:>100

# 组合搜索
org:vercel language:typescript stars:>500

快捷键

在仓库页面按 ? 查看所有快捷键。

快捷键功能
.打开 Web 编辑器
T文件搜索
L跳转到行号
B查看 Blame
Y获取永久链接
S聚焦搜索框
G C跳转到 Code
G I跳转到 Issues
G P跳转到 Pull Requests

URL 技巧

# 在线 VS Code 编辑器
github.com → github.dev
# 例如:github.dev/user/repo

# 查看原始文件
raw.githubusercontent.com/user/repo/main/file.txt

# 比较分支
github.com/user/repo/compare/main...dev

# 比较时间范围
github.com/user/repo/compare/main@{7.days.ago}...main

# 下载单个文件夹(使用 download-directory.github.io)

日常协作高频动作

下面几个动作在团队协作里非常高频:

  • 评论代码时优先用 Y 生成永久链接,避免主分支变动后定位失效
  • 查“谁改过这行”时直接用 B 打开 Blame
  • 提交 PR 前先看 Files changed,确认是否混入无关改动
  • Review 大 PR 时按文件类型或模块拆开看,比整包扫更不容易漏

如果你经常需要在多个仓库之间来回查代码,善用搜索条件和永久链接,收益会非常明显。

Profile README

创建与用户名同名的仓库,添加 README.md

### Hi 👋

- 🔭 Currently working on ...
- 🌱 Learning ...
- 📫 Reach me at ...

![GitHub Stats](https://github-readme-stats.vercel.app/api?username=YOUR_USERNAME&show_icons=true&theme=dark)

GitHub Gist

代码片段分享工具。

# GitHub CLI 创建 Gist
gh gist create file.js --public --desc "My snippet"

# 列出 Gist
gh gist list

# 克隆 Gist
gh gist clone <gist-id>

GitHub CLI

# 安装
scoop install gh

# 登录
gh auth login

# 常用命令
gh repo create myproject --public
gh repo clone user/repo
gh pr create --title "feat: add feature" --body "description"
gh pr list
gh pr merge 123
gh issue create --title "Bug: ..." --body "..."
gh issue list
gh release create v1.0.0 --generate-notes

通知与协作建议

GitHub 容易让人“消息很多,但真正重要的没盯住”。可以优先整理这几件事:

  • 只 watch 真正需要跟进的仓库
  • 对高频噪音仓库改成自定义通知级别
  • PR review、CI 失败、被 @ 提及 应该优先级最高
  • 重要 issue / PR 可以用保存搜索或项目板持续跟踪

常见问题

为什么链接里的代码行数总变

通常是因为你复制的是分支上的普通链接,而不是固定 commit 的永久链接。按 Y 后再复制,稳定性会高很多。

为什么搜不到明明存在的代码

先确认:

  • 搜索的是代码还是仓库
  • 是否加了过多过滤条件
  • 代码是否已被索引
  • 搜索词是否被分词或大小写影响

Web 编辑器和本地开发怎么选

  • 临时改文档、看配置、快速修小问题:github.dev
  • 涉及依赖安装、构建验证、批量改动:本地开发更稳

延伸阅读

.gitattributes

# 语言统计排除
*.min.js linguist-generated
docs/** linguist-documentation

# 行尾处理
* text=auto
*.sh text eol=lf
*.bat text eol=crlf

GitHub Pages

# .github/workflows/deploy.yml
name: Deploy to Pages
on:
  push:
    branches: [main]

permissions:
  contents: read
  pages: write
  id-token: write

jobs:
  deploy:
    runs-on: ubuntu-latest
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - uses: actions/checkout@v4
      - run: npm ci && npm run build
      - uses: actions/upload-pages-artifact@v3
        with:
          path: dist
      - id: deployment
        uses: actions/deploy-pages@v4

参考链接

阅读建议
  • - 先读标题和摘要,再结合目录决定从哪个章节开始精读。
  • - 看到具体命令、配置或步骤时,尽量在自己的环境里同步验证。
  • - 这类文档通常和本地环境有关,建议同时打开终端或编辑器对照操作。
适合谁看
  • - 希望把零散经验整理成长期可复用工作流的人
  • - 正在搭建开发环境、统一工具链或排查构建问题的开发者
  • - 希望阅读时顺手建立自己的操作清单或收藏体系的人
执行前检查
  • - 先浏览标题、摘要和目录,带着问题阅读会更高效
  • - 确认本机 Node、包管理器、终端和仓库依赖版本是否一致
  • - 如果页面里提到相关文档,尽量一起打开对照,效果通常更完整
同类内容
← 上一篇Git 进阶技巧