マークダウン

提供: MoodleDocs
移動先:案内検索

マークダウンについて

マークダウンはMoodleのシンプルなテキスト入力フォーマットを拡張したもので、強調(太字、斜体)、構造(箇条書き、見出し)、リンク(画像や他のウェブリソースへのリンク)を簡単に追加することができます。

テキストを入力するには、テキスト入力エリアまたはテキストボックスにテキストを入力し、段落の終わりでリターンキーを2回押して、段落の終わりと次の段落の始まりの間に空白行を残します。

マークダウンの使用

マークダウンを使用するには:

  1. エディタプリファレンス(ユーザメニュー経由)で 'プレインテキストエリア' を選択する
  2. '変更を保存する' ボタンをクリックします。
  3. テキスト入力エリアの下にあるドロップダウンメニューから、'Markdownフォーマット' を選択します。

テキストを強調する

マークダウンでは、イタリック体、太字、太字のイタリック体という3段階の強調を追加することができます。これは、アスタリスクで強調したいテキストを囲むことによって実現されます 。例

*イタリック体*
**太字**
***太字のイタリック体***

強調は、単一の単語、連続した単語、あるいは単語の一部に付加することができます:

a *single* word(単一の単語)
***a sequence of words***(連続した単語)
in**distinguish**able(単語の一部)

アンダースコア(_)はアスタリスクと置き換えて使用することができます。

見出し

マークダウンでは、テキストを見出しで細分化することができます。6つのレベルがありますが、通常のテキストでは3つ以上使用することはまれです。例えば、あなたが現在読んでいるテキストには3つのレベルの見出しが使用されています。

行頭に1つ以上のハッシュ文字(#)を付けると、見出しを作成することができます。1つのハッシュは最も大きく重要な見出しで、6つのハッシュは最も重要でない、または最も小さい見出しになります。

# セクションの見出し
## サブセクションの見出し
### サブサブセクションの見出し

など。

最初の2レベルの見出しは最も一般的なもので、テキスト版でより目立つように別の方法で作成することができます(ただし、出力は前の方法と同じです)。この代替方法では、次のようにタイトルの下に等号(=)またはハイフン(-)の行を使用します。

セクションの見出し
===============
サブセクションの見出し
------------------

リスト

リストとして認識されるには、すべてのリストの前に空白行が必要です。空白行がないと、リストとして表示されません。

箇条書きのリスト

箇条書きのリストは、各行の最初にアスタリスクを付け、箇条書きの内容の前にスペースを入れることで作成することができます。このスペースは重要ですので、忘れないように注意してください。

* 1番目
* 2番目
* 3番目

番号付きリスト

同様に、番号付きリストも、各行の先頭に数字を入れ、スペースを入れ、関連するテキストを入れることで作成できます。

1. 1番目
2. 2番目
3. 3番目

インデントされたリスト

箇条書きと番号付きリストの入れ子やインデントが可能で、一つの構造の中に箇条書きと番号付きリストを混在させることもできます:

* トップレベルの箇条書きリスト1
  * サブの箇条書きリスト
  * サブの箇条書きリスト2 
* トップレベルの箇条書きリスト2  
1. 番号付きリスト1
   1. 入れ子の番号付きリスト
2. 番号付きリスト2

引用句

各行の先頭に山括弧(>)を付けることで、引用部分を示すことができます。この文字は、多くの電子メールソフトが引用部分を示すのに使用しているため、選ばれました。出力は通常、引用部分を両方のマージンからインデントします。

> これは2行に渡って > 引用された段落です

段落の最初の行の頭に角括弧を1つだけ使用することで、入力の手間を省くことができます。

> これは、数行に渡っている
にもかかわらず、すべて1つの
引用段落となっています。

Webのリンク

Webリソースへのリンクを作成するには、2つの方法があります: 1つは、読者にクリックしてもらいたいテキストを角括弧で囲み、インラインでリンクを貼る方法で、その直後に移動するページのURLを、スペースやギャップを空けずに括弧で囲みます。また、URLの後に引用符でリンクのタイトルを追加することもできます。

文中の[リンクの例](http://example.com/ "任意のタイトル") です。

タイトルが提供されている場合、ユーザがリンクテキストにマウスを合わせたときに表示される 'ツールチップ' に表示されます。上に表示されているリンクで試してみてください。

長いリンクの場合は、脚注のスタイルで、2つ目の角括弧の中にリンクを識別する短い名前(短い説明の単語、フレーズ、または単に数字)を付けることで、テキストの流れを乱すことを避けることができます。

文中の[リンクの例][例]です。

次に、文書内の他の場所、できればリンクのある段落の直後か、文書の下部にある他のリンクURLとまとめて、そのidに関連するURLを定義します:

[例]: http://example.com/ "任意のタイトル"

この2番目の例の出力は、最初の例と見分けがつきません。これは、作業中のドキュメントをきちんと整理しておくことで、その後の編集に役立つということです(特に他の人と一緒に作業する場合)。

リンク先のテキストをURLと同じにしたい場合は、角括弧の中にURLを記述するのが近道です:

<http://moodle.org/>

画像

画像は、Webリンクと非常によく似た方法で含まれますが、その前には感嘆符が付きます。'altテキスト'(altは代替の意味)は、さまざまな理由で画像を見ることができないユーザのために提供されるものなので、視覚的な手がかりがなくても理解できるテキストでなければなりません。このようにすることで、マークダウンでテキストを編集している人に、画像の目的を思い出させる、またはヒントを提供することにもなります。

'タイトル' は、ユーザが画像にカーソルを合わせたときに小さなポップアップで表示されるため、追加情報を提供することができます。

![altテキスト](/path/img.jpg "任意のタイトル")

また、Webリンクのように、すべてのURLを '脚注' スタイルの参照でまとめておくことで、文書を整理することができます。画像には、短い固有の名前を付けるだけです。

![alt text][photo]

といったように、文書内の任意の場所で、その名前と画像ファイルを関連付けます。

[photo]: /url/to/img.jpg "任意のタイトル"

これは例です:

![Google logo](http://www.google.com/images/logo.gif "The Google logo")

アクセシビリティの観点からも重要な 'altテキスト' は、画像へのリンクが切れたり、一時的に利用できない場合に、ブラウザが使用することが多いでしょう。

![壊れた画像のためのaltテキスト](http://example.com/intentionally.broken.link "この画像が表示されることはありません")

関連項目