Ferret の使い方

エディタとプレビュー

プロジェクトのファイルを開いて編集し、Markdown と Mermaid をプレビューします。内蔵のブラウザで開いたプレビューは、ほかの Web ページと同じように録画してレビューできます。

#ファイルを開いて編集する

  • ファイル(ファイルツリー): ⌘⇧E / CtrlShiftE。ファイル名で絞り込む、再読込、すべて畳む があります。
  • ファイルを名前で開く…: ⌘P / CtrlP。
  • ⌘S / CtrlS で保存します。変更したファイルを閉じると <name> の変更を保存しますか? と尋ねられ、保存、保存しない、キャンセル を選べます。
  • 保存していない編集がある間にディスク上のファイルが変わったときは、ディスクの内容を読み込む か 自分の変更を残す を選びます。

エディタは Monaco です。テキストでないファイルは代わりにビューアで開きます。画像(拡大・縮小でき、SVG はコードとしても表示可能)、シークバー付きの動画と音声、PDF、そのほかのバイナリファイルはサイズと先頭のバイトの 16 進表示です。ビューアは読み取り専用で、プロジェクトのフォルダの外にあるファイルや、フォルダの外へ出るシンボリックリンクの先にあるファイルは表示しません。

準備中

ファイルツリーからのファイルの作成、名前の変更、削除。

#Markdown と Mermaid のプレビュー

プレビューできるのは .md、.markdown、.mdx、.mmd、.mermaid です。Mermaid はアプリに同梱しているので、オフラインでも図を描けます。

  • プレビューを横に並べる: エディタの隣に表示
  • プレビューを開く: 内蔵のブラウザ(ade-preview://)で表示。録画してレビューできます

#ドキュメントを録画でレビューする

  1. Markdown のファイルを開き、プレビューを開く を押します。
  2. いつもどおり録画します。仕様書や設計書を読みながら話し、おかしいところを囲みます。
  3. 止めます。指摘には URL の代わりに、プロジェクトからのファイルの相対パスが入ります。
  4. Agentへ送信 で、ドキュメントを直してもらいます。
内蔵のブラウザでの Markdown のプレビュー

GitHub でこのページの翻訳を手伝う (新しいタブで開きます)