使い方
VS Code 拡張
VS Code の中で、Markdown を見たまま編集します。本文・表・図を直接編集し、必要なときはソースへ。個人・法人とも、業務・商用を含めて無料で利用できます。
使い始める
VS Codeの拡張機能ビューで「Nagi.md」を検索してインストールするか、Visual Studio Marketplaceから入手します。VSIXファイルは「拡張機能 → … → VSIXからのインストール」で取り込みます。Windows用インストーラーでは、ZIPをすべて展開してInstall-Nagi.cmdを実行します。導入・更新後は文書を保存し、コマンドパレットから「開発者: ウィンドウの再読み込み」を実行してください。
- Markdownファイル(
.md・.markdown)を開きます。Nagi.mdを既定のMarkdownエディターに設定している場合は、そのままNagi.mdが開きます。 - ソース表示で開いた場合は、右上のプレビューボタン、またはCtrl+Kに続けてVを押すと横にNagi.mdが開きます。Ctrl+Shift+Vは現在のエディターグループに開きます。
- 表示された本文をクリックして編集します。ソースとNagi.mdの編集内容は相互に反映されます。
拡張のインストールだけでは既定のMarkdownエディターの設定は変更しません。「エディターを指定して再度開く」でNagi.mdを選び、既定に設定すると次回から直接開けます。新規文書はコマンドパレットの「Nagi.md: 新規Markdownを作成」から作れます。
macOSでは標準操作のCtrlを⌘に読み替えてください。独自のキー割り当てがある場合はそちらが優先されます。
保存はVS Codeの設定に合わせて
保存はVS Codeの自動保存設定(files.autoSave)に従います。手動で保存する場合はCtrl+Sを押します。保存先のない新規文書は、最初にCtrl+Sで保存先を指定してください。
off- 自動保存しません。
afterDelay- VS Codeの
files.autoSaveDelayに従って保存します。 onFocusChange- 本文・エディター・ウィンドウからフォーカスが外れたときに保存します。
onWindowChange- VS Codeのウィンドウが非アクティブになったときに保存します。
外部ツールの変更と入力が別の箇所なら両方を統合します。同じ箇所で競合すると入力を残して自動保存を止めます。比較画面で残す内容を選び、解決してから保存してください。
編集と検索
- ソースへ切り替える:タブ右上のコードのボタンでVS Codeのソースエディターを開きます。Altを押しながらクリックすると横に開きます。Nagi.md内の
</>ボタンは、拡張内のソース表示を切り替えます。 - 検索と置換:本文にフォーカスがあるとき、Ctrl+Fで検索、Ctrl+Hで置換します。macOSの置換は⌘+Option+Fです。F3/Shift+F3で次・前の一致へ移れます。
- 表:セルをクリックして編集し、Tabで次のセルへ移ります。右クリックで行・列を追加・削除し、ハンドルのドラッグで並べ替えます。
- 図:Mermaid・PlantUMLの図をクリックすると定義が開き、書き換えると表示に反映されます。
- 画像:貼り付けやドロップで追加できます。保存済み文書では保存先と形式を選び、新規文書では画像データを埋め込みます。
- PDF:「出力 → ブラウザで印刷…」または「PDFを保存…」を使います。直接のPDF保存にはインストール済みのEdge/Chrome/Chromiumを使います。
Undo/RedoはVS Codeの文書履歴を共有します。標準の閲覧用プレビューは、コマンドパレットの「Markdown: プレビューを開く」で利用できます。
変更内容を、文書の見た目で確認
ソース管理などでMarkdownの差分を開くと、読み取り専用の差分プレビューを表示します。追加を緑、削除を赤で示し、書き換えたブロックは変わった語だけを色分けします。上の帯から前後の変更へ移動でき、「テキスト差分を開く」で行ごとの比較やステージ操作へ戻れます。
Gitで管理している文書では、エディター右上の差分のボタンで、前回のコミット(HEAD)からの変更を同じ画面に表示できます。保存していない入力も含めて比較し、もう一度押すと編集画面へ戻ります。
主な設定
VS Codeの設定画面で設定名を検索してください。検索・アウトライン・本文幅・テーマなどの「Nagi.md:」コマンドはコマンドパレットから使えます。キーは「キーボード ショートカット」で割り当てられます。
nagi.diffPreview.openAutomatically- 差分プレビューを自動で開きます。既定はオンです。
nagi.diffPreview.replaceTextDiff- テキスト差分の代わりに差分プレビューを開きます。オフにすると横に開きます。既定はオンです。
nagi.syncPosition- ソースとの選択・スクロール位置を同期します。既定はオンです。
nagi.pdf.browserPath- PDF出力用ブラウザーを自動で検出できない場合に実行ファイルの絶対パスを指定します。
nagi.windowsAppPath- Windows版へ切り替えるときの
Nagi.exeの場所を指定します。
対応環境と文書の保護
制限モードでも使えます。読み取り専用の文書は編集せず、WSL/SSHでは元のホストのURIを保って画像や相対リンクを扱います。外観設定はSettings Syncに対応し、VS Codeの高コントラストテーマにも合わせます。「アプリで開く」はWindowsのローカル環境で利用できます。
見たまま編集で保存すると、変更した部分のMarkdown表記が整えられる場合があります。原文の表記を保ちたい場合はソース表示で編集してください。各版の対応範囲はアプリ一覧をご覧ください。VS Code拡張の利用条件は、拡張に同梱のLICENSE.txtと同じ内容です。