Markdown Buddy › ZennとQiitaの記事をローカルで書く
ZennとQiitaの記事をローカルで書く
ZennもQiitaも、記事の実体はMarkdownファイルです。zenn-cliやQiita CLIを使えば、記事は手元のフォルダに .md として並び、Gitで履歴を残せます。ただし、その .md をどこで書くかは自分で決めることになります。Markdown Buddyはそのフォルダをそのまま開き、ツリー表示、記事をまたぐ検索、編集できるプレビューを与えます。
書きはじめるまで
- zenn-cliまたはQiita CLIで記事のフォルダを用意します。Zennなら articles/、Qiitaなら public/ の下に .md が並びます。
- Markdown Buddyでそのフォルダを開きます(⌘⇧O)。配下のすべての .md がツリー表示のサイドバーに並び、タブで行き来できます。
- 記事を選んで書きます。⌘⇧Rでレンダリング、ソース、左右分割を切り替え、⌘Sで保存します。
- 保存すればCLIのプレビューが追従します。公開はいつも通りGitとCLIで行います。Markdown Buddyはファイルを読み書きするだけで、公開フローには一切入り込みません。
ローカルで書くと変わること
ブラウザのエディタでは届かないところに、フォルダを直接扱うと手が届きます。
- front matterのtopicsやtagsでサイドバーを絞り込み、書きかけの記事だけを並べられます
- ⌘⇧Fで過去の全記事を横断検索し、前に書いた説明をすぐ引けます
- ⌘⇧Gのリンクマップで記事どうしの参照を俯瞰し、切れたリンクを見つけられます
- ネットワークがなくても下書きを進められ、移動中でも手が止まりません
- Gitの履歴がそのまま残るので、公開前の推敲を何度でも重ねられます
日本語入力で書式が崩れない
変換中のテキストに手を入れるエディタは、日本語入力を壊します。確定前の候補が飛ぶ、文字が消える、書式が二重にかかる。Markdown Buddyは設計上の絶対禁止事項として、IMEの変換中は一切の再描画を行いません。変換が確定してから書式を当て直します。長い日本語の文章を書き続けても、入力が途切れません。
つまずきやすいところ
- front matterがプレビューに文字列として出る場合は、設定(⌘,)で折りたたみ表示に切り替えてください。アウトラインにも余計な見出しは出ません。
- 記事フォルダではなくリポジトリのルートを開くと、READMEや設定ファイルの .md も一覧に混ざります。articles/ や public/ を直接開くほうが見通しが良くなります。
- 画像の相対パスは、その .md が置かれたフォルダを基準に解決されます。CLIのプレビューと同じ挙動です。
- 全角スペースで字下げした行は、Markdownの記法として解釈されないことがあります。これはMarkdownの仕様で、CLI側のプレビューでも同じ結果になります。
よくある質問
Zennの公開フローは変わりますか
変わりません。Markdown Buddyはローカルの .md を読み書きするだけで、zenn-cliやGitの操作には関与しません。いつものコマンドをそのまま使えます。
Qiita CLIでも同じように使えますか
はい。記事がローカルの .md として存在するワークフローであれば、プラットフォームを問いません。Hugo、Astro、Docusaurusの原稿でも同じです。
プレビューはZennの表示と完全に一致しますか
いいえ。Markdown BuddyはGitHub風の標準的なMarkdownを描画します。Zenn独自の記法やメッセージ記法は再現しないため、最終確認はzenn-cliのプレビューで行ってください。書いている最中の見通しを良くするための道具です。
データは収集されますか
一切ありません。サンドボックス内で動き、ファイルを開くためのネットワーク通信も行いません。原稿が手元のディスクから出ることはありません。