Markdownの記法一覧

Markdownの主な記法についての情報です。

Markdownの概要

Markdown（マークダウン）は、文書を記述するための軽量なマークアップ言語です。デジタル文書を活用する方法として考案されました。

特徴は、

• 手軽に文章構造を明示できること
• 簡単で、覚えやすいこと
• 読み書きに特別なアプリを必要としないこと
• それでいて、対応アプリを使えば快適に読み書きできること

などです。Markdownはジョン・グルーバー（John Gruber）によって2004年に開発され、最初は Daring Fireball: Markdown で公開されました。その後、多くの開発者の手を経ながら発展してきました。

ただし、Markdownには「方言」と呼ばれる派生版が存在しますので、お使いの環境でその記法が使用可能かどうか確認してお使いください。

Markdownの基本的な構文

Markdownの基本的な構文について、Markdownで記述した説明文を含むテキストファイルを作成しました。

Markdown形式のファイルは、Pandocというツールを用いることで、多様な形式に変換できます。LaTeXがインストールされている場合、MarkdownファイルをPDFに変換することも可能ですが、本記事では、HTMLファイルを印刷でPDF形式に変換したり、またwkhtmltopdfというアプリケーションを使用してPDFに変換しました。

実際のファイルを用いて、Markdownの構文がどのように変換されるかを確認してみてください。

Markdownファイル

「Markdownの基本的な構文について」ファイルを、ZIP形式で圧縮したファイルを以下から、ダウンロードできます。ファイル名は、「Markdown_Basicsyntax1.md」としています。

htmlファイル

「Markdown_Basicsyntax1.md」を、Pandocでhtml形式のファイルに変換しました。

1ファイルとなるように、画像ファイルを埋め込んでいます。以下の、バッチファイルで変換しました。

• 見出し付きで、htmlファイルに変換します。

"C:\Program Files\Pandoc\pandoc.exe" -s %1.md -f commonmark_x --toc --toc-depth=3 -V colorlinks=true -V filecolor=blue  -t html5 --embed-resources --standalone --css stylesheet.css -o %1.html

• 見出しなしで、htmlファイルに変換します。

"C:\Program Files\Pandoc\pandoc.exe" -s %1.md -f commonmark_x -V colorlinks=true -V filecolor=blue  -t html5 --embed-resources --standalone --css stylesheet.css -o %1.html

Markdownの基本的な構文について.html

PDFファイル(1)

上記のhtmlファイルを、PDF形式で印刷したファイルです。

印刷したPDFファイルでは、しおりの作成はできないようです。

Markdownの基本的な構文について_pdf_print.pdf

PDFファイル（2）

上記のhtmlファイルをwkhtmltopdf を使用して、PDFに変換したファイルです。以下の、バッチファイルで変換しました。wkhtmltopdf は、見出しをしおりとして作成することができます。PDFファイルを公開する際には、しおりがある方が利便性が高いでしょう。

wkhtmltopdf ですが、こちらからご使用のOSの環境に合わせてダウンロードしてください。

それから、”–user-style-sheet” オプションを使用するすることで、CSSファイルを指定する事ができます。

• –user-style-sheet cssファイル

このオプションを指定する際には、警告が表示されることがありますが、”-enable-local-file-access”オプションを指定することで警告は解消されます。

"C:\Program Files\wkhtmltopdf\bin\wkhtmltopdf.exe" --page-size A4 --minimum-font-size 32 --enable-local-file-access --user-style-sheet stylesheet.css %1.html %1.pdf

Markdownの基本的な構文について.pdf

WORDファイル

Pandocで、docxに変換したファイルです。docxに変換では、html構文は、サポートされていないようです。以下の、バッチファイルで変換しました。

C:\Program Files\Pandoc\pandoc.exe -s %1.md -f commonmark_x -t docx -o %1.docx --css stylesheet.css --toc --toc-depth=3 -V colorlinks=true -V filecolor=blue

Markdownの基本的な構文について.docx

Markdownの構文（Basic Syntax、Extended Syntax）

Markdown Guide は、Markdown の使用方法を説明した、詳細なリファレンス ガイドがあります。

その中に、以下の2つのSyntax（構文）の説明がありました。

以下は、一部繰り返しになりますが、この2つに沿った構文の説明資料をMarkdownで作成し、htmlとPDFに変換したファイルです。上述の「Markdownの基本的な構文」より、若干説明している構文が増えています。

• Basic Syntax
  • The Markdown elements outlined in the original design document.
• Extended Syntax
  • Advanced features that build on the basic Markdown syntax.

htmlファイル

Pandocを使用して、htmlに変換したファイルです。

PDFファイル

Pandocを使用して、見出しなしでhtmlに変換した後、wkhtmltopdf でPDFに変換したファイルです。

記法の一覧

Markdownの記法を表にまとめました。環境によっては使用できない構文もありますのでご注意ください。

数式の表示

Markdown＋MathJaxで、数式の表示が可能です。以下のURLを参照ください。

リンクの挿入ツール：Create Link

 Chromeに拡張機能で、「Create Link」というのがあります。Chromeで表示しているページのリンクををMarkdownの書式でコピーすることができます。

以下のリンク形式でコピーできます。Markdown以外に、プログ作成の時にも利用できます。

• plain text ([page title] [page URL])
• HTML link ([page title]
• markdown
• mediawiki

入手

以下の、Chrome ウェブストアから入手できます。

Create Link – Chrome ウェブストア

設定

以下の設定で使用しています。ツールバーに表示していいると何かと便利です。

参考URL

以下のURLも参考にしてください。