目次  I Love Cui

Markdown

Markdown とは

Markdown は、John Gruber によって開発が始められた軽量マークアップ言語です。マークアップの種類は非常に制限された HTML マークアップのサブセットになっています。また、文法が簡単なため覚えやすいのが特徴です。実際、基本的なマークアップの種類は、目次、段落、改行、文字列の強調、引用、リスト、水平線、リンクしかありません。

Markdown のもう一つの特徴は、そのマークアップは HTML のタグとは違い、テキストファイルにマークアップしてもそのまま読めるほど可読性が高いことです。電子メールからの発想らしいのですが、テキストファイルのまま文章の構造が分かる仕組みになっています。

Markdown のタグ

この節では個々のマークダウンの文法について眺めていきます。これは、Basic Syntax という記事の要約です。

Headings

Headings タグは目次を表します。行頭の # に続けてスペースを一つ置きその後に目次を記述します。# は HTML の h1 タグ に対応します。## は h2タグ に ### は h3 タグに対応します。

Paragraphs

1行または複数の行が空白行で区切られると、段落になリます。p タグに相当します。

Line Breaks

行の中の2つ以上の空白の後に改行すると段落内の改行とみなされます。br タグに相当します。

Empasis

文字列の強調は、その文字列を * と * または ** と ** で囲みます。それぞれ em タグ と strong タグに対応します。

Blockquotes

文頭に > とスペースが記述された行は引用文となります。blockquote タグに相当します。

List

- の後に空白一文字を置くとその行はリストとみなされます。- は順序なしリスト ul タグ、1. は順序付きリストを現わします。順序付きリストは 1. foo, 2. bar ... のようにも書けますが 1. foo, 1. bar ... はリストの番号が自動的に割り当てられます。ol タグに相当します。

Code Blocks

コードブロックは先頭にスペースを4つ並べることで表現します。

Images

画像は ![代替の文字列](画像のURL) で表示できます。

Horizontal Rules

行頭に --- (ハイフン3つ)を並べると水平線にレンダリングされます。hr タグに相当します。

リンクを作成するには、ブラケットでリンクの文字列を囲みそれに続いて()で囲んだ URL を記述します。 [Duck Duck go](https://duckduckgo.com) のような使い方をします。

Characters You Can Escape

タグに使われる記号をエスケープして使いたいときはバックスラッシュを使います。たとえば、\#のような使い方をします。

まとめ

以上が基本的な Markdown のタグです。詳しい説明は、Markdown Guide の Basic Syntax に解説されています。文法についての細かい注意点も書かれていますので、うまくレンダリングできないときはこの文書を参照すると理由が分かることがあります。

Markdown でネット検索すると日本語の情報や用例は沢山見つかるのでそれを参照すると便利です。個々のタグを覚えるよりも、まず Markdown を使って文書を作成してみることが大切です。

Markdown の文書の拡張子は .md になることになっているようですが、Windows の場合は .text でも構いません。

Markdown 文書の HTML への変換

Markdwon の原稿を HTML に変換するのは pandoc がお勧めです。

$ pandoc foo.md > foo.html

のような使い方をします。また、次のように -s オプションと -t html5 オプションを使うと完全な HTML5 文書を作成できます。

$ pandoc -s -t html5 foo.md > foo.html
戻る