MarkdownをHTMLとして公開する

メモやドキュメントはMarkdownで書き、WebはHTMLを要求します。.mdのソースをCMSやページテンプレに貼れるマークアップに変換します。

このガイドで使う道具

やりたいこと

CMSの入力欄、ヘルプページ、メールテンプレートなど、HTMLを要求する場所は多いですが、原本はMarkdownの方が書きやすいです。見出し・リスト・コードブロック・リンクを実際のタグにするきれいなマークアップを出力します。

使い方

Markdownを貼り付け、断片(既存ページに貼る用)か完全な文書(doctypeまで付く)を選んで変換します。結果はシリアライズされたHTMLで、コピーするか.htmlで保存します。

  • 断片はCMSの本文欄向き、文書は拡張用の単独ページ骨格です。
  • コードブロックは言語ヒントをclassとして残すのでシンタックスハイライトが効きます。

具体例

READMEの1節を断片として変換すると、h2/h3の見出しと順序なしリストがHTMLになってプロジェクトのwikiページにそのまま貼れます。同じソースを文書として変換すれば共有可能な単独ページになります。

注意点

構文はMarkdownプレビューと同じセット(見出し・強調・コード・リンク・画像・リスト・引用・水平線)で、表組みや脚注はありません。安全でないリンクURL(javascript:等)は危険な属性を出さずプレーンテキストになります。