JSONを追加
有効なJSONを貼り付けるか、.jsonファイルを開きます。
JSONをMarkdownに変換
JSONのデータ形状に合わせ、同じ項目を持つオブジェクト配列は表へ、入れ子のオブジェクトは見出しとリストへ変換します。スキーマの意味を推測する機能ではありません。
0 文字
リッチプレビュー
プロジェクトノート
読みやすい文書は、分かりやすい構造から始まります。
確認すること
- 見出しの階層
- 正しく開くリンク
- 再利用しやすいファイル
ダウンロード前にプレビューを確認します。
ファイルはこのブラウザタブ内で処理されます。
JSONを読みやすいMarkdownにする手順
変換前のJSONも変換後のMarkdownも編集できます。
構造を確認
オブジェクトのキー、配列順、入れ子、表の列を確認します。
編集して保存
説明用に不要な値を削除し、Markdownをコピーまたは.mdで保存します。
対応内容
JSONの形に合わせて表現を選択
機械向けのデータを、人がレビューしやすい文書構造へ移します。
オブジェクト配列を表へ似たキーを持つレコード配列は、キーを列名にしたMarkdown表へ変換します。
入れ子を見出しとリストへオブジェクト、配列、文字列、数値、真偽値、nullを階層に沿って表示します。
無効なJSONを失わない解析に失敗した場合はJSONコードブロックとして残し、入力を修正できるようにします。
活用例
JSONをMarkdownへ変える用途
APIドキュメント
小さなレスポンス例を表やリストにし、READMEへ掲載します。
設定内容のレビュー
キーと入れ子を読みやすいアウトラインへ変換し、変更点を説明します。
データのスナップショット
同じ項目を持つレコードを表にし、議事録や報告へ貼り付けます。
よくある質問
JSONからMarkdownへの変換について
JSONの型は保持されますか？
値は文字として見える形にしますが、Markdown自体にJSONの型やスキーマを保持する仕組みはありません。
JSONコメントにも対応していますか？
標準JSONにはコメントがありません。コメント付き拡張形式は解析に失敗し、コードブロックとして残る場合があります。
どんな配列が表になりますか？
主にオブジェクトで構成される配列です。キーが異なる場合は全キーを列として扱い、空の値が生じることがあります。