文档

功能

这趟导览按你正在做的事分组:阅读、审查、 浏览 GitHub、编辑,以及把文档带出去。PullMark 有意不做完整的 审查客户端——它只显示改动里的 Markdown;代码部分,你惯用的工具依然 是对的。

阅读

  • 忠实于 GitHub 的渲染——表格、任务列表、脚注、 提示框、可折叠的 <details>、语法高亮、Mermaid 图表和 KaTeX 数学公式($…$ / $$…$$),全部离线可用。 只含 [toc] 的段落会变成带链接的目录;==highlight==~sub~^sup^ 也照样渲染。
  • 点开细看——图片、图表和块级公式在可平移缩放的 浮层中打开;“存储为…”和“共享”导出的正是你细看的内容 (图表为真正的 SVG)。
  • 活的文件——在任何编辑器里保存,文档随即重新渲染; 相对路径的图片与链接自动解析,点击指向另一个 Markdown 文件的链接会 就地打开它(当它位于已打开的“位置”中时,以预览方式)。
  • 导航——大纲侧边栏(⌥⌘O)、⌘F 页内查找、⇧⌘F 搜索侧边栏里的所有文件,以及 ⌘K 的“快速打开”,可达 标题、文件、PR、最近使用——也可以直接把路径或 GitHub 链接粘进去。
  • 阅读高度的 blame——一条安静的作者边栏:每段连续 区块一个头像,悬停看提交,点击看完整行历史。文件在 GitHub 上时用 GitHub 的 blame API,其余情况用普通的 git blame
  • 阅读的舒适度——主题、栏宽、行号 (设置)、浏览器式缩放、浅色/深色、 全屏,以及按文档记忆的阅读位置。

审查拉取请求

  • 渲染差异——新增、删除、修改的区块直接在渲染页面上 高亮;改动小到讲得通时给出词级差异;行内或并排(⌥⌘L);还有原始的 “源码差异”(⌘2)和最终的“结果”(⌘3)。整段搬家的 文字得到一枚安静的“已移动”标签,而不是红加绿的噪音。
  • 审查会话就地呈现——已有评论出现在它们讨论的区块 下方;悬停区块即可“开始审查”、“添加单条评论”或 “添加建议”(铅笔则把区块编辑成一条建议)。 审查连同结论一并提交,或作为待完成审查保存到 GitHub。
  • PR 的处境——总览页头部显示审查结论(已批准、 已请求更改、需要审查)、每位审查者的裁定(佩戴徽章的头像,等待中的 审查者列在旁边),以及一枚 CI 检查胶囊,展开即是完整检查列表——时长、 必需标记,和通往每项检查日志的链接。这一切每分钟安静刷新一次。
  • 会话,变得可读——总览页上一条按时间排列的时间线: 评论与审查结论按序呈现,每次审查的行内评论嵌在其总结之下,卡片上 写明所讨论的文件。支持回应表情、编辑和删除自己的评论,评论框就在 时间线末尾。对所有人开启(“设置 ▸ 通用 ▸ 审查”可把会话 收起来)。
  • 保持最新——打开的 PR 每分钟检查一次;分支前进时 横幅提示刷新,你的草稿评论安然无恙。离线写下的评论会排队,能上传时 就上传。
  • 审查请求——等待你审查的 PR 出现在侧边栏,带未读 计数。PR 中的图片和仓库相对链接按 PR 的提交解析。

GitHub,不必开浏览器

  • Markdown 链接在应用内打开——点击 github.com/…/blob/… 链接,PullMark 直接渲染(第一次点击 会询问;⌘-点击执行你默认的反面)。来源栏钉着 owner/repo @ ref · path,并留着回 GitHub 的路。
  • 浏览整个仓库——把仓库的 Markdown 树装进 “位置”,切换分支、 与其他分支比较、查看 blame——私有仓库用的就是 PR 已在用的凭据, 抓取的内容从不落盘。
  • 分支与工作树——本地检出佩戴分支标签;标签的菜单 能把工作树作为独立的“位置”打开,也能远程读取其他分支。某个分支 已有本地工作树时,本地永远优先于远程。

编辑与提交

  • 原地编辑——点区块的铅笔(或按 ⌘E 编辑整篇), 区块就在渲染页面里变成编辑器;⌘↩ 保存,Esc 取消。保存有防护, 防止文件在你眼皮底下被改,并有版本记录供“还原上次编辑”使用。
  • 在应用里提交——⌃⌘K 打开该文件所在仓库的提交 面板:挑选文件、写提交信息、可选推送,直接提交到 main 之前还有 一道防护。

与历史比较

  • 任意文件,任意版本——工具栏的“比较” 按钮(时钟加箭头)把工作文件与它最近 25 次提交中的任何一次、或任何 本地/远程分支相比较——渲染呈现,改动的词高亮,和拉取请求一模一样。 按钮上一枚安静的小点表示文件有未提交的改动。
  • “我刚才改了什么?”——一个菜单项 (显示 → 与上次提交比较)或一条命令 (pullmark --diff file.md,见 命令行)。文件继续变化,差异就继续 跟进——看着智能体的修改带着高亮逐次落地。

把文档带出去

  • 导出——PDF(连续一整页)或完全自包含的 HTML; “共享”能把文档送到 macOS 能送达的任何地方。
  • 两种口味的拷贝——⌘C 是给 Docs/Slack 的富文本; ⌥⌘C 是底下的 Markdown。
  • 打印——⌘P,无论缩放多少都按 100% 打印。
  • Quick Look(快速查看)——在 Finder 里按空格, 用 PullMark 自己的渲染预览 Markdown。

一条属于你的工具栏

右键点击工具栏——或“显示 → 自定义工具栏…”——调出原生的自定义 面板:把从不用的拖走,其余的重新排列,加上可调间距。 每种视图各自记住自己的排布,跨启动保留:本地文件、GitHub 文档、 拉取请求文件和 PR 总览是四条相互独立的工具栏,身在哪个视图就自定义 哪一条——就像 Mail 的撰写窗口保有自己的工具栏一样。

默认项之外,面板里还备着一些初始隐藏的项目:原始 源码开关、放大 / 实际大小 / 缩小栏宽选择器、添加页边批注 (在该功能开启期间),以及 GitHub 文档专属的共享—— 分享的是文档的 github.com 页面,绝不是裸链接——和 重新载入,它把分支重新解析到当前最新提交;对钉在特定 提交上打开的文档则保持禁用,并写明原因。开箱状态下一切如常;其余都 收在面板里。工具栏一页列出了每个视图的 项目。

其余种种

  • 窗口与标签页——⌘N 打开独立窗口;可合并为原生 标签页。外部打开落在最前面的窗口。
  • pullmark 命令——在任何终端打开文件、 文件夹和工作树。见命令行
  • 默认应用控制——一键让 PullMark 接管 .md,升级弄丢绑定时它会自己发现。
  • 内置更新——已签名、已公证的版本,一键更新, 外加一张“新增功能”说明。
  • 隐私姿态——GitHub 内容经 API 抓取、只存内存, 文档从不被复制到任何地方。隐私页面有完整 说明。