ファイルを読み、変更する内容を決める
READMEやメモを読むためのオンラインMDビューアをお探しですか？.mdファイルを開き、「プレビュー」を選ぶと閲覧画面になります。編集する場合は「エディター」または「分割表示」に切り替えてください。ソースは確認・保存できます。
よく使う編集にはキーボードショートカットを使い、既存の原稿があればファイルを開いてください。下書きのローカル保存は任意です。ブラウザーに保存した下書きはこのブラウザープロファイルに属し、クラウドバックアップではありません。
ソースを表示したまま使えるエディター
MDファイルを編集せずに読む
見出し、リスト、表、コードを閲覧するには、MDファイルビューアとしてプレビューを使います。ソース欄が隠れて読みやすくなり、エディターに戻っても入力内容は失われません。
数式や図などを挿入
表のひな形を作る、インライン/ブロック数式を追加する、Mermaidの例を挿入する、ローカルのラスター画像を埋め込むことができます。挿入後はソースを直接編集してください。
書きながらMarkdownをライブプレビュー
「分割表示」を選ぶと、ソースとレンダリング結果を横に並べて確認できます。入力後に少し待つと変更が反映されるため、表の配置、コードブロック、対応する数式を確認できます。長い文書では手動でプレビューを更新してください。
作業方法を選ぶ
エディター、プレビュー、分割表示を切り替え、フォーカスモードや文字の見た目、ズームを調整できます。持ち運べるコピーが必要なときはMarkdownをダウンロードしてください。
実際に必要な文書から始めましょう
プロジェクトのREADME
READMEをすぐに読むために開き、セットアップ手順を変更するときは分割表示を使います。
# プロジェクト名 **このプロジェクトでできること**の概要です。 ## はじめに ```bash npm ci ``` ## 次のステップ - [ ] 動作する例を追加する - [ ] ドキュメントを確認する
- 冒頭で内容が分かる。
- コマンドがコードブロック内にある。
- チェック項目が具体的。
図を含む判断メモ
判断の理由とフローチャートをひとつのソースファイルにまとめます。
# レビューフロー ```mermaid flowchart LR A[下書き] --> B[レビュー] B --> C[公開] ``` 共有する前に、レビュー担当者が内容を確認します。
- 図の構文が正しい。
- ラベルが読みやすい。
- 図の内容が文章で説明されている。
文書を開き、プレビューして保存
ファイルを開くか内容を貼り付ける
.mdファイルを開くには「ファイルを開く」を選ぶか、Markdownをエディターに貼り付けます。GitHubのREADMEは、まず元ファイルを保存してください。Webアドレスを入力しても文書はインポートされません。
読む、または変更内容を並べて確認
ソース欄を隠して読むには「プレビュー」を選びます。編集する場合は「分割表示」にすると、作業しながらライブプレビューを確認できます。ツールバーを使えば、すべての記法を覚えなくても見出し、リンク、リスト、表を追加できます。
後から編集できるコピーを保存
ソースを端末に保存するには「MDをダウンロード」を選びます。レンダリング済みの文書にはHTML、共有用の閲覧コピーにはPDFツールが便利です。ブラウザーの下書き保存は任意であり、ファイルを保存する代わりにはなりません。
共有する前に結果を確認
| 内容 | 操作 | 確認できること |
|---|---|---|
| 意図しない書式 | ツールバー操作の後に生成されたソースを確認します。 | 太字やリストは通常のMarkdownとして残り、手動で変更できます。 |
| 下書きの復元 | 保存を有効にして小さな下書きを編集し、再読み込み後に復元します。 | 保存先は端末ごとで、ブラウザーの設定によって削除される場合があります。 |
| AIが作成した文章 | 事実関係を確認し、閉じられていないコードや未対応の数式を修正します。 | 書式は読みやすさを向上させますが、内容の正しさを保証するものではありません。 |
この手順について
オンラインMDビューアとして、編集せずに使えますか？
はい。「ファイルを開く」で.md文書を選び、「プレビュー」に切り替えてください。ソースを変更せず、レンダリング済みの内容を読めます。編集するときは「エディター」または「分割表示」に戻してください。
書きながらオンラインでMDファイルをプレビューするには？
ソースを貼り付けるかファイルを開き、「分割表示」を選びます。入力後に少し待つとプレビューが更新されます。長い文書で自動更新が止まった場合は「プレビューを更新」を使ってください。編集や閲覧に文書のアップロードは必要ありません。
Markdownの記法をすべて知らなくても使えますか？
ツールバーからよく使う記法を挿入でき、サンプルも編集の出発点になります。ソースを表示しておくと、ボタンで追加される内容も確認できます。
下書きはどこに保存されますか？
ローカル保存を有効にした場合、このブラウザー内にのみ保存されます。端末間で同期されず、ブラウザーの保存データを消去すると下書きも削除されます。確実に残すにはMDをダウンロードしてください。
非常に長い文書ではどうなりますか？
編集とソースのダウンロードは引き続き利用できます。エディターの応答性を保つため、自動プレビューを一時停止する場合があります。結果を確認するときは手動で更新してください。
HTMLタグに対応していますか？
下線、上付き文字、下付き文字、キー表示、ハイライト用の、属性を含まない一部の書式タグに対応しています。その他の生HTMLはテキストとして表示されます。
数式や図を使えますか？
対応しているKaTeX数式とMermaidコードブロックをレンダリングします。無効な記法には印が付き、レンダリング結果を書き出す前にソースを修正できます。
文書の取り扱いについて
- エディターとプレビューはブラウザー内で動作します。
- 下書きのローカル保存は任意で、無効化または消去できます。
- PDFダウンロードは別のサーバー処理です。印刷とMD/HTMLのダウンロードは端末内で行えます。
形式に関する参考資料CommonMarkのヘルプGitHub Flavored Markdown仕様
再現できる問題を報告ブラウザー、選択した設定、機密情報を含まない小さなサンプルをお知らせください。個人情報を含むファイルはメールで送信しないでください。
