Ferret の使い方

エディタとプレビュー

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

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

  • ファイル(ファイルツリー): ⌘⇧E / CtrlShiftE。ファイル名で絞り込む、再読込、すべて畳む があります。
  • ファイルを名前で開く…: ⌘P / CtrlP。
  • Finder(Windows ではエクスプローラー、Linux ではファイルマネージャー)からファイルをタブバーかエディタにドラッグすると開きます。プロジェクト内のファイルはエディタかビューアで開きます。プロジェクトの外のファイルを取り込むには、ファイル にドロップします。プロジェクトにコピーされます。ここにドロップしたフォルダはプロジェクトとして開きます。ファイル からドラッグしたファイルも同じように開きます。開いている Markdown ファイルに画像や動画をドロップしたときは、開く代わりにそのファイルに埋め込みます(Markdown に画像や動画を埋め込む を参照)。
  • ⌘S / CtrlS で保存します。変更したファイルを閉じると <name> の変更を保存しますか? と尋ねられ、保存、保存しない、キャンセル を選べます。
  • 保存していない編集がある間にディスク上のファイルが変わったときは、ディスクの内容を読み込む か 自分の変更を残す を選びます。

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

#ファイルツリーでファイルを扱う

VS Code と同じように、ファイル の中でそのままファイルを扱えます。項目を右クリックします。プロジェクトの一番上で操作するときは、ツリーの下の空いた所を右クリックします。名前はツリーの中で直接入力します。

  • 新しいファイル / 新しいフォルダ: ツリーの上のボタンか右クリック。新しい項目は、選んでいるフォルダの中、選んでいるファイルの隣、またはプロジェクトの一番上にできます。src/routes/index.ts のようにスラッシュを含む名前を入力すると、途中のフォルダも作ります。新しいファイルはエディタで開きます。空のフォルダでは、ファイル に このフォルダは空です と、新しいファイル と 新しいフォルダ のボタンが出ます。
  • 切り取り、コピー、貼り付け: ⌘X / CtrlX、⌘C / CtrlC、⌘V / CtrlV か右クリック。フォルダは中身ごとコピーします。複製 は元の隣にコピーを作ります。名前がすでに使われているときは、コピーの名前は name copy、その次は name copy 2 になります。
  • 項目をフォルダの上(プロジェクトの一番上なら空いた所)にドラッグすると移動します。ドロップするときに ⌥ / Ctrl を押していると、移動ではなくコピーします。Finder(Windows ではエクスプローラー)からドラッグしてきたファイルやフォルダはプロジェクトにコピーされ、元のものはそのまま残ります。
  • 名前を変更: F2 / Enter / F2 か右クリック。
  • 削除: ⌘⌫ / Delete / Delete か右クリック。Ferret は先に確認してから、項目をゴミ箱(Windows ではごみ箱)へ移すので、元に戻せます。削除したファイルのタブは閉じます。保存していない編集があったときは、確認の画面にそう出ます。
  • 元に戻す: ⌘Z / CtrlZ で、直前の新規作成、名前の変更、移動、貼り付け、複製を取り消します。削除した項目はゴミ箱から戻します。
  • パスをコピー(⌥⌘C / ShiftAltC)と 相対パスをコピー(⌥⇧⌘C / CtrlShiftAltC)は、パスをクリップボードに入れます。
  • Finder で表示(Windows では エクスプローラーで表示、Linux では 含まれているフォルダを開く): ⌥⌘R / ShiftAltR。ターミナルで開く は、そのフォルダ(ファイルならそのファイルがあるフォルダ)で新しいターミナルのタブを開きます。
  • ファイルでは、開く でエディタで開き、既定のアプリで開く で OS がその種類のファイルに使うアプリで開きます。
  • ⌘ / Ctrl-クリックか ⇧ / Shift-クリックで複数の項目を選ぶと、まとめて切り取り、コピー、移動、削除できます。
  • Esc で入力中の名前を取り消します。

開いているタブは、名前を変えたり移動したりしたファイルに付いていき、保存していない編集も残ります。Ferret は同じ名前の既存のファイルやフォルダを上書きせず、すべてをプロジェクトのフォルダの中に収めます。..、絶対パス、外を指すシンボリックリンク、.git の中のもの、フォルダをそれ自身の中へ移すこと、どれかの OS で使えない名前(/ \ < > : " | ? *、制御文字、末尾の空白やドット、CON や NUL などの Windows の予約名)は受け付けません。1回のコピーやドロップで扱えるのは 10,000 項目、1 GB までです。

#Markdown と Mermaid のプレビュー

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

Markdown ファイルでは、エディタの上で ソース と プレビュー を切り替えます。プレビューはいつでも編集でき、そのまま入力できます。テキストに戻るには ソース を押します。どちらも同じ内容を表示し、保存、未保存の印、閉じるときの確認も同じように働きます。

  • 見出し、段落、リスト、チェックボックス、表、リンク、太字、斜体、インラインコードにそのまま入力できます。行の先頭で #、-、1.、> に続けて空白を入力すると、見出し、リスト、引用になります。
  • 行の先頭(または空白の後)で / を入力すると、一覧からブロックを選べます。見出し、箇条書き・番号付き・チェックのリスト、表、コードブロック、引用、区切り線です。各項目には、何ができるかと Markdown での書き方が出ます。続けて入力すると絞り込め、↑ ↓ と Enter で選びます。Esc を押すと / は文字のまま残ります。表は見出しの行の付いた 3 × 3 で始まり、Tab で次のセルへ移り、最後のセルでは行を足します。表の中で / を入力すると、行や列の追加と削除、表の削除ができます。
  • コードブロックはソースのまま編集し、隅に言語を出します。Mermaid のコードブロック(mermaid か mmd)は、既定で図を出します。右上の コード を押すか図をダブルクリックするとソースを編集でき、カーソルがブロックの外へ出ると図に戻ります。ソースに誤りがあれば、そのメッセージと コードを直す を出します。図は sandbox の枠の中で描き、保存する Markdown は書いたままです。
  • フロントマター(先頭の --- のブロック)は文書の上にテキストとして出て、そこで編集できます。
  • 変更していない部分は、見出しの書き方、リストの記号、空行、表の揃え、改行コードも含めて、書かれたとおりに保存します。編集したブロックはできるだけ元の書き方を保ち、保てないときはそのブロックを標準的な Markdown の形(リストは -、見出しは #)で書きます。
  • プロジェクト内の画像と動画は表示します。ほかのサイトの画像は読み込まず、代わりにホスト名を表示します。ファイル内のそのほかの HTML はテキストとして表示します。

.mdx ファイル(ソースだけで編集します)、.mmd、.mermaid ファイルには、代わりに読み取り専用のプレビューがあります。

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

#Markdown に画像や動画を埋め込む

画像(PNG、JPEG、GIF、WebP、SVG、AVIF)や動画(MP4、WebM、MOV)を Markdown ファイルにドラッグすると、ソース でも プレビュー でも、ドロップした位置に埋め込みます。

  • すでにプロジェクト内にあるファイル(ファイル からドラッグしたものを含む)は、Markdown ファイルからの相対パスでつなぎます。コピーはしません。
  • プロジェクトの外のファイル(Finder、デスクトップ、Windows ではエクスプローラー)は、先に Markdown ファイルの隣のフォルダにコピーします。assets、images、media、img のどれかがすでにあればそれを使い、なければ assets フォルダを新しく作ります。名前の空白は - になり、同じ名前があるときはコピーの名前が name-2 になります。元のファイルはそのまま残ります。
  • 画像は ![name](assets/name.png)、動画は <video src="assets/name.mp4" controls></video> と書きます。GitHub でもそのまま再生できる形です。どちらも プレビュー に表示されます。
  • 画像は 50 MB まで、動画は 500 MB までです。1回のドロップでコピーできるのは 50 ファイル、1 GB までです。一緒にドロップしたほかのファイルは、いつもどおりエディタで開きます。

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

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

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