学习

Markdownで文書を作成する方法

/ ,
簡体中文日本語

Markdown

Markdown は John Gruber が 2004 年に考案した軽量マークアップ言語です。読み書きしやすいプレーンテキストで文書を作成できます。
変換ツールを使えば、Markdown の文書を HTML、Word、画像、PDF、EPUB などの形式に出力できます。
文書の拡張子は通常 .md または .markdown です。

Markdown の応用

GitBook などのツールを使い、Markdown で電子書籍を書くこともできます。

GitHub、簡書、Reddit、Diaspora、Stack Exchange、OpenStreetMap、SourceForge など、多くのサイトがドキュメントやフォーラムの投稿に Markdown を使っています。

Markdown の基本構文

見出し | Title

Markdown の見出しには 2 つの形式があります。

1. = と - でレベル 1・2 の見出しを作る

Markdown
这是H1的标题
===========

这是H2的标题
-----------
markdown_title1.png

2. # を使う

行頭の # の数で、レベル 1～6 の見出しを表します。レベル 1 は # 1 つ、レベル 2 は # 記号 2 つ、以下同様です。

Markdown
# 一级标题

## 二级标题

### 三级标题

#### 四级标题

##### 五级标题

###### 六级标题
markdown_title2.png

段落 | Paragraph

段落に特別な記法は必要ありません。そのまま文章を書けます。段落内で改行するには、行末に半角スペースを 2 つ以上入れて Enter キーを押します。

markdown_paragraph1.png

段落の間に空行を入れると、別の段落になります。

markdown_paragraph2.png

斜体と太字 | Phrase Emphasis

Markdown では *テキスト* または _テキスト_ で斜体を、**テキスト** または __テキスト__ で太字を表します。

用法

表示

*斜体テキスト*

斜体テキスト

_斜体テキスト_

斜体テキスト

**太字テキスト**

太字テキスト

__太字テキスト__

太字テキスト

***太字斜体テキスト***

太字斜体テキスト

___太字斜体テキスト___

太字斜体テキスト

リスト | List

Markdown は順序なしリストと順序付きリストをサポートしています。

順序なしリスト

順序なしリストでは、アスタリスク* やプラス記号+、またはマイナス記号- を使います。記号の後に半角スペースを 1 つ入れてから、項目の内容を書きます。

Markdown
* 第一项
* 第二项
* 第三项

+ 第一项
+ 第二项
+ 第三项

- 第一项
- 第二项
- 第三项
markdown_list1.png

順序付きリスト

順序付きリストは数字と . 記号を使って表します。例：

Markdown
1. 第一项
2. 第二项
3. 第三项
markdown_list2.png

リストの入れ子

リストの入れ子は、子リストの項目の前に半角スペース 4 つを追加するだけです：

Markdown
1. 第一项：
    - 第一项嵌套的第一个元素
    - 第一项嵌套的第二个元素
2. 第二项：
    - 第二项嵌套的第一个元素
    - 第二项嵌套的第二个元素
markdown_list3.png

ブロック引用 | Blockquotes

Markdown のブロック引用では、段落の先頭に > を置き、その後に 空白 を入れます。

Markdown
>Hi, this is xxxbrian.
>Brian's Blog
>等青春轻飘的烟雾把少年的欢乐袅袅曳去，之后，我们就能取得一切值得吸取的东西。 ——普希金

また、ブロックは入れ子にできます。1 つの > 記号が最外層、2 つの > 記号が第 1 層の入れ子で、以下同様です：

Markdown
> 最外层
> > 第一层嵌套
> > > 第二层嵌套

ブロック内でリストを使用

Markdown
> 区块中使用列表
> 1. 第一项
> 2. 第二项
> + 第一项
> + 第二项
> + 第三项

リスト内でブロックを使用

Markdown
+ 第一项
    > Brian's Blog
    > Hi, this is xxxbrian.
+ 第二项
markdown_blockquotes.png

コード | Code

段落内の関数名やコード片は、バッククォート` で囲みます。たとえば `コード` のように書きます。関数名 printf() を表示する例です。

Markdown
`printf()`函数

コードブロック

コードブロックは、行頭に スペース 4 つ またはタブ文字を 1 つ入れて記述します。

Markdown
$(document).ready(function () {
    alert('RUNOOB');
});

表示結果は次のとおりです：

$(document).ready(function () {
alert('RUNOOB');
});

また、```でコードを囲み、言語を指定することもできます（指定しなくてもかまいません）：

JavaScript
$(document).ready(function () {
    alert('RUNOOB');
});

表示結果は次のとおりです：

JavaScript
$(document).ready(function () {
    alert('RUNOOB');
});

ハイパーリンク | Link

リンク の使用方法は次のとおりです：

Markdown
[链接名称](链接地址)

或者

<链接地址>

例：

Markdown
这是一个链接 [Brian's Blog](https://xxxbrian.me)

リンクの例：Brian's Blog

リンクアドレスを直接使用する

Markdown
链接 <https://xxxbrian.me>

リンク <https://xxxbrian.me>

参照形式のリンク

参照形式では、本文中のリンクにラベルを付け、対応する URL を文書の末尾などにまとめて定義できます。

Markdown
这个链接用 1 作为网址变量 [Google][1]
这个链接用 Brian's Blog 作为网址变量 [xxxbrian][xxxbrian]

[1]: http://www.google.com/
[xxxbrian]: https://xxxbrian.me

markdown_link.png

画像 | Images

Markdown の画像構文は次のとおりです：

Markdown
![alt 属性文本](图片地址)

![alt 属性文本](图片地址 "可选标题")
  • 先頭に感嘆符 !
  • 続けて角括弧の組の中に画像の代替テキストを書きます。
  • 丸括弧の組の中に画像の URL を書き、必要であれば引用符で囲んだ 'title' を追加します。

使用例：

Markdown
![xxxbrian 图标](https://raw.githubusercontent.com/xxxbrian/xxxbrian.github.io/master/img/xxxbrian-192x192.png "xxxbrian")

表 | Tables

Markdown で表を作成するには、| で異なるセルを区切り、- で表ヘッダーとその他の行を区切ります。

Markdown
|  表头   | 表头  |
|  ----  | ----  |
| 单元格  | 单元格 |
| 单元格  | 单元格 |

表の整列

  • -: は、内容と見出しを右揃えに設定します。
  • :- は、内容と見出しを左揃えに設定します。
  • :-: は、内容と見出しを中央揃えに設定します。
Markdown
| 左对齐 | 右对齐 | 居中对齐 |
| :-----| ----: | :----: |
| 单元格 | 单元格 | 单元格 |
| 单元格 | 单元格 | 单元格 |
markdown_sheet.png

エスケープ | Backslash Escapes

Markdown では多くの特殊記号を特定の意味を表すために使用しています。特定の記号を表示する必要がある場合はエスケープ文字を使用します。Markdown ではバックスラッシュで特殊文字をエスケープします：

Markdown
**文本加粗** 
\*\* 正常显示星号 \*\*

Markdown では、次の記号の前にバックスラッシュを付けることで、通常の記号として挿入できます：

TEXT
\   反斜线
`   反引号
*   星号
_   下划线
{}  花括号
[]  方括号
()  小括号
#   井字号
+   加号
-   减号
.   英文句点
!   感叹号
  • Loading...
  • Loading...
  • Loading...
  • Loading...
  • Loading...