README マークダウン プレビューとブラウザファースト編集
このガイドは、ブラウザーファーストの Markdown ワークスペースが、ページを離れることなく README スタイルのコンテンツの下書き、プレビュー、共有を行う最速の方法である場合に使用してください。
エディタはライブプレビュー、分割ビュー、プリセットを提供します。下書き用のツールであり、リポジトリ履歴やレビューの代わりにはなりません。
こんなときに使う
ライブ プレビュー機能があり、必須のエディターのインストールが必要ない、迅速な README、リリースノート、または Runbook のドラフトが必要です。
まず確認すること
Markdown 自体に問題があると考える前に、ビュー モード、プレビュー レンダリング、および共有状態を一緒に確認してください。
ガードレール
下書きはこの端末のブラウザストレージに保存されます。サイトデータを消去すると失われ、共有リンクをコピーするまで URL には何も含まれません。
READMEアウトライン
最終的な詳細を記述する前に見出しの構造が必要な場合は、README プリセットから開始します。
# Project Overview
## Install
## Usage
リリースノート
読者が素早くスキャンできるよう、ジョブの書式変更が明確に行われる場合は、リリースノートの下書きを使用します。
# Release Notes
- Added safer share handling
- Fixed layout regressions
障害対応ランブック
マークダウンがマーケティング コピーではなく運用上のガイダンスになる場合は、ランブック パターンに切り替えます。
## Triage
1. Confirm impact
2. Capture rollback window
3. Share updates
Markdown エディターは、重いオーサリング スタックに移行せずに、高速なドラフト、ライブ プレビュー、制御された共有動作が必要な場合に最も強力です。
- 最初に分割ビューを使用して、ソースとレンダリングされた出力が一緒に表示されるようにします。
- ローカルの下書きストレージと明示的な共有 URL を別個のワークフローとして扱います。
プリセット リンクは安全に広く共有できますが、明示的なドラフト URL は、正確な Markdown 本文を送信する必要がある場合にのみコピーする必要があります。
- ドラフトが URL に対して大きすぎる場合は、強制的に共有状態にするのではなく、ローカル ブラウザー ワークフローを使用し続けます。
- diff は、レビュー範囲が 1 つのアクティブなドラフトをプレビューするのではなく、2 つのドキュメント リビジョンを比較する場合に使用します。