ドキュメント

機能

やりたいことごとにまとめたツアーです。読む、レビューする、GitHub を ブラウズする、編集する、文書を取り出す。PullMark はあえてフルレビュークライアントには していません——表示するのは変更の中の Markdown で、コードにはいつものツールが 引き続き最適です。

読む

  • GitHub に忠実なレンダリング — 表、タスクリスト、脚注、アラート、 折りたたみの <details>、シンタックスハイライト、Mermaid 図、KaTeX 数式 ($…$ / $$…$$)を、すべてオフラインで。[toc] だけの 段落はリンク付きの目次になり、==highlight==~sub~^sup^ もレンダリングされます。
  • クリックで拡大表示 — 画像・図・ブロック数式はパンとズームのできる オーバーレイで開きます。「別名で保存…」と「共有」は、見ているそのものを 書き出します(図は本物の SVG として)。
  • 生きているファイル — どのエディタから保存しても文書は再レンダリング されます。相対パスの画像とリンクは解決され、別の Markdown ファイルへのリンクをクリック すればその場で開きます(開いている「場所」内にあるファイルは プレビューとして)。
  • ナビゲーション — アウトラインサイドバー(⌥⌘O)、⌘F のページ内検索、 ⇧⌘F のサイドバー全ファイル検索、そして ⌘K の「クイックオープン」。見出し・ファイル・PR・最近の 項目に飛べるほか、パスや GitHub の URL をそのまま貼り付けられます。
  • 読むための高度の 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.mdCLI 参照)。 ファイルが変わり続けても差分は追従します——エージェントの編集が保存されるそばから、 ハイライト付きで届くのを見ていられます。

文書を取り出す

  • 書き出し — PDF(切れ目のない 1 ページ)または完全に自己完結した HTML。「共有」は macOS が送れる先ならどこへでも文書を送ります。
  • 2 種類のコピー — ⌘C は Docs や Slack 向けのリッチテキスト、⌥⌘C は 元の Markdown。
  • 印刷 — ⌘P。ズームに関係なく、つねに 100% で。
  • Quick Look — Finder でスペースキーを押せば、PullMark 自身の レンダリングで Markdown をプレビューします。

あなたのものになるツールバー

ツールバーを右クリック——または 表示 →「ツールバーをカスタマイズ…」——で、ネイティブのカスタマイズ パレットが開きます。使わないものはドラッグして外し、残りを並べ替え、伸縮自在のスペースを足す。 ビューの種類ごとに配置が保存され、起動をまたいで記憶されます。ローカルファイル、GitHub の ドキュメント、プルリクエストのファイル、PR の概要はそれぞれ別のツールバーで、いままさに 見ているビューのツールバーをカスタマイズします——メールの作成ウィンドウが独自のツールバーを 持つのと同じ流儀です。

デフォルトの一式のほかに、パレットには最初は非表示の項目が控えています。生ソースの 「ソース」トグル、「拡大」/「実際のサイズ」/「縮小」「本文幅」ピッカー、「マージンノートを追加」(機能が有効な あいだ)、そして GitHub ドキュメント向けの 「共有」——共有されるのはその文書の github.com ページで、生のリンクは決して渡しません——と 「再読み込み」。「再読み込み」は ブランチを現在の先端に解決し直し、特定のコミットで開いた文書では、理由の表示とともに無効の ままです。初期状態では何も変わりません。残りはパレットの中に。 ツールバーのページに全ビューの項目一覧があります。

そのほかのすべて

  • ウィンドウとタブ — ⌘N で独立したウィンドウを開き、ネイティブのタブに 統合できます。外部からのオープンは最前面のウィンドウに届きます。
  • pullmark コマンド — どのターミナルからでもファイル・ フォルダ・ワークツリーを。コマンドラインを参照。
  • デフォルトアプリの管理 — ワンクリックで PullMark を .md の ハンドラにでき、アップグレードで関連付けが外れれば気づいて知らせます。
  • 内蔵アップデート — 署名・公証済みのリリースを、ワンクリック更新と 「新機能」シートで。
  • プライバシーの姿勢 — GitHub の内容は API 経由で取得されてメモリ内に とどまり、文書がどこかへコピーされることはありません。詳しくは プライバシーのページへ。