Markdownとは
Markdownは2004年にJohn Gruberが考案した軽量マークアップ言語です。 プレーンテキストで書きながら、見出し・リスト・リンク・画像などの構造化された文書を表現できます。 GitHub、Qiita、Notion、VS Codeなど多くのツールでサポートされており、 技術ドキュメントやREADMEの作成に広く使われています。
GFM(GitHub Flavored Markdown)
GFMはGitHubが標準Markdownを拡張した方言で、以下の追加機能を持ちます。
- テーブル: パイプ(|)とハイフン(-)で表を作成
- タスクリスト:
- [x]でチェックボックス付きリスト - 取り消し線:
~~テキスト~~で取り消し表示 - 自動リンク: URLを自動的にリンクに変換
基本的なMarkdown記法
見出し
# 見出し1 ## 見出し2 ### 見出し3
テキスト装飾
**太字** *斜体* ~~取り消し線~~ `インラインコード`
リスト
- 項目1 - 項目2 - ネスト 1. 番号付き 2. リスト
リンクと画像
[リンクテキスト](https://example.com) 
HTML→Markdown変換のオプション
HTML→Markdown変換では、出力形式をカスタマイズできます。
- 見出しスタイル: ATX(# 記号)またはSetext(下線)
- コードブロック: フェンス(```)またはインデント(4スペース)
- リストマーカー: ハイフン(-)またはアスタリスク(*)
- リンク形式: インライン形式または参照形式
セキュリティについて
このツールはブラウザ上で完結しており、入力データは外部サーバーに送信されません。 HTMLプレビュー表示時はDOMPurifyによるサニタイズ処理を行い、 scriptタグやイベントハンドラなどのXSS攻撃ベクタを除去しています。