作業メモ
Markdown・表・コードを貼る前に整える手順
Markdownは、貼り付け先によって表、コードブロック、改行の見え方が変わります。先に表データと不可視文字を確認し、必要な形式へ整えます。
ページ更新日:
表、コード、本文を分けて整える
同じ貼り付けでも、表形式とコードブロックでは壊れやすい点が違います。
表は区切りと列数を見る
CSVやTSVからMarkdown表へ変換する前に、列数と先頭ゼロを確認します。
コードは改行と空白を見る
インデント、改行コード、不可視文字が混ざると、レビューや実行時に差分が読みにくくなります。
次にやること
1. 表データをMarkdownへ整える
CSVやTSVを貼り付け、列崩れやゼロ落ちを確認してから表にします。
- Markdown表ツール
CSV / TSV とMarkdown表を相互変換します。
- CSV列抽出・並び替え
表に出す列だけを選びます。
- 先頭ゼロ落ち防止
コード値を貼る前にゼロ落ちを避けます。
2. JSONやコードを読みやすくする
構造データやコード風テキストは、貼る前に整形して確認します。
- JSON整形
JSONを整形し、構文エラーを確認します。
- Slack・Discord引用整形
引用やコードブロック向けに文面を整えます。
- Markdownリンク一括生成
URLとタイトルの一覧からリンクを作ります。
3. 空白と不可視文字を確認する
貼り付け後に見つけにくい空白、改行、ゼロ幅文字を事前に見ます。
- 改行と空白の整形
余分な空白や改行を整えます。
- 不可視文字の可視化と除去
ゼロ幅スペースやBOMなどを確認します。
- 文字数カウント
文字数やバイト数を見たいときに使います。
詰まりやすい場面
- READMEやIssueに表を貼る前に崩れを避けたいとき
- JSONやコードブロックをチャットへ貼る前に整形したいとき
- 見えない空白や改行差分でレビューが読みにくいとき
具体例と判断基準
よくある失敗例
セル内のpipeをそのまま貼る
Markdown表では`|`が列区切りになるため、貼り付け先の方言に合わせてescapeまたはコード表記を選びます。
コードfenceと本文のbacktickが衝突する
内容に連続backtickがある場合は外側fenceを長くするか、貼り付け先の対応形式を確認します。
改行をセル内で保持できると思う
表セルの改行対応は貼り付け先で違います。`<br>`可否や複数行表現をプレビューします。
入力・作業サンプル
表の例
`id,name,note` のid=`001`、note=`A|B`なら、001を文字列として保ち、pipeのescape方法を貼り付け先で確認します。
コードの例
JSONは構文確認後に整形し、言語名付きfenceへ入れます。秘密値やログの個人情報は貼る前に除きます。
before
CSVを直接READMEへ貼り、列数、pipe、先頭ゼロ、コードfence、改行が崩れてから修正する。
after
元データを保存し、表/コード/本文へ分類、列とescapeを整形、対象サービスでプレビューしてから貼る。
この順番で見る理由
元データの列構造と保持すべき値を先に確認すると、Markdownへ変換した後の見た目修正でデータを失わずに済むためです。
迷ったときの判断基準
表にする
列が固定され、横幅とセル内容が貼り付け先で読める場合に選びます。
コードブロックにする
空白・改行・記号をそのまま見せたいデータやコードに使います。
添付にする
列が多い、大きい、改行を多く含む、秘密除去後も長い場合は本文へ無理に貼りません。
関連ツールを使う流れ
- 元データ: CSV列抽出や先頭ゼロ確認で表に出す列と値を整えます。
- 整形: Markdown表、JSON整形、引用整形から用途に合うものだけを使います。
- プレビュー: 実際のREADME/Issue/チャットのプレビューで差を確認します。
Markdownの解釈はサービスごとに違います。最終表示は実際の貼り付け先で確認してください。
作業を止めて確認する条件
- 貼り付け先のMarkdown方言やHTML許可が不明
- 表に秘密情報・個人情報が残っている
- 列数や引用符が崩れたCSVをそのまま変換している
- プレビューで横スクロールやセル崩れが読めない
ツールを使わない判断
貼り付け先にCSV添付・テーブルエディタ・コードスニペット機能があり、原形式を安全に保てる場合は、その機能を使ってMarkdownへ再変換しません。
対象外: すべてのMarkdown方言で同じ表示になること、貼り付け先の権限・公開範囲の保証。
最終チェックリスト
- 元データを保持し、必要列だけにした
- pipe・backtick・改行・先頭ゼロを確認した
- 秘密情報と不可視文字を確認した
- 実際の貼り付け先でプレビューした
まず開くツール
各段階で最初に開くものだけを並べています。
必要なら見るページ
用語や周辺ツールが必要なときだけ使います。
- 文章・テキストカテゴリ
空白、改行、不可視文字、置換のツールを見たいとき。