Markdownを試す

チートシート

Markdownチートシートとは？

Markdownチートシートは、ドキュメント・READMEファイル・メモ・Webコンテンツを書く際に使えるクイック構文リファレンスです。すべてのルールを暗記する代わりに、見出し・リスト・リンク・テーブル・コードブロックの実績あるパターンをコピーして活用できます。

このページはスピード重視で設計されています。サンプルはすぐにコピーできる状態で、CommonMarkの規約とMarkdownオリジナルプロジェクトに基づいています。MarkdownフォーマッターやMarkdownエディターと組み合わせて使うと便利です。

ドキュメントポータルやリポジトリに公開する場合、構文の互換性は重要です。このクイックリファレンスには、GitHubのドキュメントやCommonMark対応エディターで広く使われるパターンが含まれています。

すべてはブラウザ上で動作します。コンテンツの作成・構文の確認中も、データはお使いのデバイス上に留まります。

Markdownチートシートの使い方

Markdown構文を参照・試すための手順です。各ステップはこのページの実際のパネルを使用します。

貼り付け・アップロード・サンプルの読み込み

左側のMarkdownを試すパネルにMarkdownを入力または貼り付けるか、アップロードをクリックしてファイルを読み込みます。サンプルをクリックするとサブスクライバーAPIのサンプルドキュメントが表示されます。右側のチートシートパネルには、基本構文・コード・テーブル・タスクリストが表示されます。

参照と練習

見出し・強調・リンク・コードブロック・テーブルにチートシートを活用してください。左パネルにパターンをコピーして試せます。CommonMarkおよびGitHub互換です。

コピーまたはダウンロード

コピーまたはダウンロードをクリックしてチートシートを保存します。クリアで白紙から始められます。すべての処理はブラウザ内で実行されます。

信頼できるMarkdownリファレンス

開発者・テクニカルライター・ドキュメントチームが使用する権威あるリファレンスです：

これらのソースの活用方法

CommonMarkをベースラインとして使用し、GitHub/GitLabのドキュメントでプラットフォーム固有の挙動を確認してから、公開前にレンダリング結果を検証してください。

主なユースケース

READMEの作成

リポジトリでプロジェクトドキュメントを書く際に、クイック構文サンプルを活用できます。

テクニカルメモ

設計書・インシデントメモ・アーキテクチャ更新を一貫したフォーマットで記述できます。

チームオンボーディング

新しいチームメンバーがゼロからルールを学ぶ代わりに、動作する構文をコピーして利用できます。

チェックリスト

デプロイ・QA・リリースのタスクリストを適切なMarkdownチェックリスト形式で作成できます。

よくある質問

これは標準のMarkdownに基づいていますか？

はい。このリファレンスは広く使われているCommonMark互換の構文に従っています。正式なルールについてはCommonMark仕様をご覧ください。

チートシート全体をコピーできますか？

はい。コピーボタンを使えば、リファレンス全体を即座にクリップボードに貼り付けられます。

ファイルとしてダウンロードできますか？

はい。ダウンロードボタンを使えば、チートシートを.mdファイルとして保存できます。

入力したテキストはブラウザ外に送信されますか？

いいえ。他のMarkdownツールと同様に、すべてはブラウザ内でローカルに処理されます。

ここでMarkdownをHTMLに変換できますか？

はい。変換出力が必要な場合はMarkdownからHTMLをご利用ください。HTMLのセマンティクスについてはMDN HTMLドキュメントをご参照ください。

乱れたMarkdownを整形できますか？

はい。スペースや構造を整えるにはMarkdownフォーマッターをご利用ください。

役立つその他のMarkdownツール

執筆・フォーマット・変換のワークフローでチートシートと組み合わせてお使いください：

Markdownチートシート