「マークダウン」(markdown)は、「軽量マークアップ言語」と呼ばれるタイプの書式です。基本的には通常のテキストファイルと同じですが、簡単な記号を付けることでHTMLに変換した際の見栄えを整えることが可能です。
まずは簡単な例を掲載します。以下のように書くと……。
# タイトル1 ## タイトル2 ### タイトル3-1 ここは本文です。 ここは**強調**です。 ここは[リンク](https://crocro.com/)です。 ここは本文です。 ### タイトル3-2 ここは本文です。ここは本文です。ここは本文です。ここは本文です。ここは本文です。ここは本文です。ここは本文です。ここは本文です。ここは本文です。ここは本文です。 ここは本文です。ここは本文です。ここは本文です。ここは本文です。ここは本文です。ここは本文です。ここは本文です。ここは本文です。ここは本文です。ここは本文です。
以下のように変換されます。
ここは本文です。 ここは強調です。
ここはリンクです。 ここは本文です。
ここは本文です。ここは本文です。ここは本文です。ここは本文です。ここは本文です。ここは本文です。ここは本文です。ここは本文です。ここは本文です。ここは本文です。
ここは本文です。ここは本文です。ここは本文です。ここは本文です。ここは本文です。ここは本文です。ここは本文です。ここは本文です。ここは本文です。ここは本文です。
特に装飾が必要なければ、普通のテキストファイルの文章のように書いてもらって構いません。ただ、改行が認識されるのは「改行2つ」からなので、そこだけ注意して下さい。
マークダウンには、方言とでも言うべき、仕様の違いが存在しています。本サイトでは「GFM」(GitHub Flavored Markdown)と呼ばれる方式を使用します。
以降、本サイトで使用しそうな仕様だけ紹介します。
マークダウン形式で書いた文書を、ローカルで確認するためのソフトを紹介しておきます。Windows、Mac、Linux問わずに使えるもので、初心者にも操作がそれほど難しくないものを選んでおきます。
「Atom」エディタは、プログラマ向けのエディタですが、便利なマークダウン表示機能を備えています。「Ctrl+Shift+M」で、現在開いているテキストファイルを、マークダウンとして表示してくれます。
テキストファイルを開く場合は、「Atom」のウィンドウにドロップすればよいです。
テキストファイルの文字コードは「UTF-8」形式が望ましいですが、「Shift JIS」にも対応しています。「Shift JIS」の場合、開いた直後は文字化けしていますが、以下の操作で文字化けを解消できます。
本文では「改行1つ」は無視されます。「改行2つ」から認識されます。
マークダウンは、元々メールの文章を装飾する書き方が元になっています。メールでは、文章中に改行して見栄えを整えることが多いです。しかし、そこで改行したいわけではなく、「30文字ぐらいで改行しよう」という理由で改行しているだけです。そうした改行を、マークダウンでは無視します。
また、段落中で一行だけ改行したい場合は、その行の末尾に半角スペースを2つ置きます。
改行1つは無視されます。 ここの改行は無視されていますよね。 改行2つは、改行として認識されます。 改行3つ以上は、改行2つと同じ見栄えに なります。一行だけの改行をしたい場合は、 行末に半角スペースを2つ起きます。 こんな感じです。
改行1つは無視されます。 ここの改行は無視されていますよね。
改行2つは、改行として認識されます。
改行3つ以上は、改行2つと同じ見栄えに
なります。一行だけの改行をしたい場合は、
行末に半角スペースを2つ起きます。
こんな感じです。
行頭に「#」を付けると、見出しになります。「#」1つが最も最上位の見出しで、「#」の数が増えていくと低位の見出しになります。
「#+半角スペース+見出し」のように書きます。
それぞれ、HTMLの「h1」タグ、「h2」タグ……に相当します。
「小説の紹介」の中では「#」3つ、つまり「###」を最上位として利用して下さい。
# 見出し1 ## 見出し2 ### 見出し3 #### 見出し4 ##### 見出し5
「見出し1」はページのタイトルに使うので、「小説の紹介」の中では使わないで下さい。
「見出し2」は小説のタイトルに使うので、「小説の紹介」の中では使わないで下さい。
「見出し3」以降を使うようにして下さい。
# 見出し1 ## 見出し2 ### 見出し3 #### 見出し4 ##### 見出し5
強調は、強調記号(アスタリスクもしくはアンダースコア)で囲むことでおこないます。
強調記号1つで囲むとHTMLの「<em>」、強調記号2つで囲むとHTMLの「<strong>」、強調記号3つで囲むとHTMLの「<em>+<strong>」で装飾されます。
強調したい際は、アスタリスク2つで囲むことを推奨します。
文章の途中で**強調**をおこないます。
文章の途中で強調をおこないます。
アスタリスク、ハイフン、アンダースコアを3つ以上書いた行は、水平線に変換できます。
記号の間にスペースがあってもよいです。
見た目のわかりやすさから、ハイフンを5個以上書くのがよいと思います。
*** --- ___ * * * - - - _ _ _ ----------
箇条書きのリストです。ハイフン、プラス、アスタリスクを行の先頭に置き、半角スペースを入れます。
ネストは、タブ文字や、2~4つを単位とした半角スペースでできます。
2つ以上のリストを続けて並べるときは、2行以上空けて下さい。1行しか空けないと、前のリストと融合してしまいます。
+ リスト1 + リスト2 + リスト2-1 + リスト2-2 + リスト2-2-1 + リスト2-2-2 + リスト3 + リスト1 + リスト2 + リスト2-1 + リスト2-2 + リスト3
箇条書きリストの数字付きバージョンです。数字+半角ドット+半角スペースで、番号付きリストになります。
数字は、きちんと連番になっていないでも構いません。たとえば、全て「1.~」のように書いても、自動で連番になります。
1. はじめに 2. マークダウンとは 1. 由来 2. 使われている場所 3. 書き方 1. はじめに 1. マークダウンとは 1. 由来 1. 使われている場所 1. 書き方
行頭に「>」を入れることで、引用になります。
ここは本文です。 > ここは引用文です。 > > ここは引用文です。 ここは本文です。
ここは本文です。
ここは引用文です。
ここは引用文です。
ここは本文です。
表組みは、「|」(バーティカルバー)を利用して区切ります。最初の行はヘッダー(見出し)部分で、2行目はヘッダーとの区切り線、3行目以降が表の本体部分になります。
また、2行目で列の横並びの方法を指定できます。「:--」とすると左寄せ、「--:」とすると右寄せ、「:--:」とすると中央寄せになります。
本サイトでは、ヘッダー部分の中身を全て空にすると、ヘッダー無しの表になります。
見出しありの表。 |列1の見出し|列2の見出し|列3の見出し| |:--|--:|:--:| |項目1|項目2|項目3| |項目1|項目2|項目3| 見出しなしの表。 |||| |--|--|--| |項目1|項目2|項目3| |項目1|項目2|項目3|
見出しありの表。
列1の見出し | 列2の見出し | 列3の見出し |
---|---|---|
項目1 | 項目2 | 項目3 |
項目1 | 項目2 | 項目3 |
見出しなしの表。
項目1 | 項目2 | 項目3 |
項目1 | 項目2 | 項目3 |
その他の整形ルールは、以下を参考にして下さい。