拡張機能を入れ、Markdown の横にプレビューを出して、バージョン・設定ファイル・配色・スクロールを整える手順
VS Code で Markdown を編集しながら、mdmark で描いた見た目を確かめるときに実行する。
vscode-v{バージョン}）から、mdmark-{バージョン}.vsix を落とすExtensions: Install from VSIX... を選び、落とした .vsix を指すVisual Studio Marketplace と Open VSX に登録したバージョンは、拡張機能の画面で mdmark を検索して入れられる。
拡張機能のタグ vscode-v{バージョン} は mdmark 本体のタグ v{バージョン} とは別で、拡張機能のバージョンと、プレビューが読む mdmark のバージョンは一致しない。
Markdown を開き、Shift+Alt+D（Mac は Shift+Option+D）を押す。
エディタのタイトルのボタンか、コマンドパレットの mdmark: プレビューを横に開く でも開く。
ショートカットとボタンは、Markdown を開いているときだけ効く。
コマンドパレットの mdmark: プレビューを開く を選ぶと、Markdown のエディタと同じ列のタブに開く。
同じ Markdown のプレビューが既に開いているときは、新しく作らず、そのプレビューを表に出す。
何も記載しないと、設定 mdmark.version の既定 latest で動く。
プレビューを開くときとリロードしたときに、GitHub のタグ一覧から最新の v{X}.{Y}.{Z} を選ぶ。
vscode- で始まる拡張機能のタグは選ばない。
タグ一覧を取れないときは、前回に選んだバージョンで描く。
{
"mdmark.version": "v0.6.0"
}
settings.json に記載する。
固定したバージョンはそのまま読み、タグ一覧を取らない。
配布物を読めないときと、バージョンを決められないときは、文書の代わりに理由と「リロード」のボタンが出る。
| 理由 | 起きるとき | 直し方 |
|---|---|---|
| オフライン | jsDelivr に届かない | ネットワークを確かめてから「リロード」を押す |
| 指定したバージョンが無い | mdmark.version に記載したバージョンの配布物が 404 |
mdmark.version を公開されているバージョンに直してから「リロード」を押す |
| バージョンを決められない | latest でタグ一覧を取れず、前回のバージョンも無い |
ネットワークを確かめてから「リロード」を押す |
「リロード」はコマンドパレットの mdmark: プレビューをリロード でも呼べる。
設定ファイルとバージョンを決め直し、配布物を読み直して描く。
新しい mdmark が打たれたときも、リロードで読み替える。
{
"mdmark.preview.liveUpdate": true,
"mdmark.preview.updateDelayMs": 300
}
打つたびに、最後に打ってから mdmark.preview.updateDelayMs ミリ秒（0〜5000）待って描き直す。
mdmark.preview.liveUpdate を false にすると、保存したときだけ描き直す。
保存していない書き換えも、描き直すときの全文に含まれる。
背面に回ったプレビューは、表に戻ったときに最後の全文で描き直す。
エディタとプレビューのスクロールは、両方向に合う。
mdmark.preview.scrollPreviewWithEditor を false にするとエディタに合わせてプレビューを動かさず、mdmark.preview.scrollEditorWithPreview を false にするとプレビューに合わせてエディタを動かさない。
mdmark.configPath（既定 mdmark.config.yaml）の features と libraries を、プレビューの描画に使う。
ワークスペースの直下から探し、無ければ mdmark の既定で描く。
features:
callout: false
libraries:
my-chart: ./libs/my-chart.js
保存すると、プレビューを描き直す。
libraries の相対 URL は、設定ファイルのあるフォルダを基準にする。
theme・extensions など、ほかのキーは読まない。
コマンドパレットの mdmark: 設定ファイルを開く で、設定ファイルをエディタで開く。
無いときは、雛形を作るかを尋ねる。
作る を選ぶと、features と libraries の記載例をコメントにした設定ファイルを作って開く。
尋ねずに作ることはない。
設定ファイルが YAML として読めないときは、文書の先頭に帯が出て、読めない行を知らせる。 前に読めた設定で描いたままになり、帯の「設定ファイルを開く」で直しに行ける。
{
"mdmark.preview.theme": "auto"
}
auto は VS Code のテーマの明暗に合わせる。
light・dark を記載すると、その配色に固定する。
固定の仕組みは テーマを上書きする。
.md へのリンクは、元の Markdown と同じ列のエディタで開く# で始まるリンクは、プレビューの中で移るmdmark.version を直したときは、プレビューを開き直すか、リロードする。
それ以外の設定は、保存するとすぐに開いているプレビューへ当たる。
Markdown の横に、タブ プレビュー {ファイル名} が開き、見出し・表・注意書きが mdmark の見た目で描かれる。
Markdown を打つと、待ちのあとにプレビューが変わる。
エディタを動かすとプレビューが同じ箇所まで動き、プレビューを動かすとエディタが同じ箇所まで動く。
プレビューのタブを閉じる。 拡張機能を使わないときは、拡張機能の画面で mdmark を無効にするか、アンインストールする。 Markdown と設定ファイルは、プレビューの操作では書き換わらない。