Markdown とは？
Markdown は # で見出し、- でリスト、バッククォートでコードなどの簡単なマーカーを使うプレーンテキスト形式です。README、ドキュメント、GitHub Issue、開発者メモでよく使われます。
web
Markdown プレビュー
GitHub Flavored Markdown をブラウザー内でプレビューし、見出しやリンクを確認して HTML をコピーまたはダウンロードできます。
Markdown 執筆 コース
この Markdown 執筆コースで学ぶ内容を紹介します。
このツールについて
DevCove Markdown プレビュー / Markdown → HTML は、README、CHANGELOG、Issue テンプレート、ドキュメントスニペットを即時ビジュアルフィードバック付きで起草するのに役立ちます。オンライン Markdown プレビューとして使い、見出しとリンクを確認し、ワークフローの次のステップ向けにサニタイズ済み HTML フラグメントをコピーまたはダウンロードできます。
使い方
README、Issue テンプレート、ドキュメント、ブログ記事を起草するときに使います:
- 左のエディターに Markdown を書くか貼り付けます。
- 右のライブプレビューで GitHub Flavored Markdown 対応を確認します。
- CMS、メール、ドキュメントツール向けのサニタイズ済み HTML フラグメントが必要なときは HTML ビューに切り替えます。
- 公開前に見出しアウトラインとリンク一覧でドキュメント構造を検証します。
- 現実的な出発点が欲しいときは README または Issue テンプレート例を読み込みます。
- 出力の準備ができたら Markdown または HTML をコピーするか、HTML ファイルをダウンロードします。
機能
README、CHANGELOG、Issue テンプレート、ドキュメント起草ワークフロー向け:
- GitHub Flavored Markdown 基本機能付きライブ Markdown プレビュー。
- エディターとプレビューの並列ワークスペース。
- 安全な HTML フラグメント向けのサニタイズ済み Markdown → HTML 変換。
- 迅速な構造レビュー向けの見出しアウトライン。
- 現在のドキュメントから抽出したリンク一覧。
- ツールバーに README と Issue テンプレート例を内蔵。
- Markdown コピー、HTML コピー、HTML ダウンロード操作。
- クライアント側処理: Markdown はブラウザー内に留まり、DevCove サーバーにアップロードされません。
- 明確な境界: 初版ではクラウド公開、画像アップロード、Mermaid、LaTeX は含まれません。
よくある質問
この Markdown プレビューはコンテンツをアップロードしますか？
いいえ。プレビューと HTML 変換はページ読み込み後ブラウザー内で実行されます。Markdown は DevCove サーバーにアップロードされません。
どの Markdown 機能に対応していますか？
初版は見出し、リスト、リンク、コードブロック、引用、テーブルなど一般的な GitHub Flavored Markdown 基本機能に対応。Mermaid 図と LaTeX は初版に含まれません。
HTML 出力は他の場所に貼り付けても安全？
HTML フラグメントは表示とコピー前にサニタイズされ、Markdown 内の生 HTML ブロックはアクティブコンテンツに昇格しません。本番システムに埋め込む前に必ず出力を確認してください。
完全な HTML ドキュメントをコピーできますか？
ツールは head、body、asset タグ付きの完全ページではなく、サニタイズ済み HTML フラグメントをコピーします。CMS フィールド、ドキュメントシステム、メールテンプレート向けに通常はこれが必要です。
リポジトリで Markdown を書くこととの違いは？
GitHub、ドキュメントサイト、Issue フォームに入る前の Markdown 起草と確認用です。IDE を開いたりコミットをプッシュしたりせず、即時プレビュー、見出し構造、リンク抽出、HTML エクスポートを提供します。
プレビューと HTML 出力が少し違って見えるのはなぜ？
プレビューはサイトの Markdown レンダラースタイルを使い、HTML 出力は DevCove CSS なしのサニタイズ済みセマンティックフラグメントです。Markdown を別システムに移すときは想定どおりです。