--- contributors: - ["Dan Turkel", "http://danturkel.com/"] - ["Jacob Ward", "http://github.com/JacobCWard/"] - ["Tomáš Hartman", "https://github.com/tomas-hartman"] translators: - ["Kenryu Shibata", "https://github.com/kenryuS"] --- Markdownは2004年にジョン グラバー(John Gruber)によって作られました。 HTMLへの変換が容易な書きやすくかつ読みやすいマークアップ言語として開発されました。 今ではHTMLの他に様々なファイル形式へ変換できます。 Markdownは構文解析の実装によって様々な派生があるマークアップ言語として知られています。 このチュートリアルでは様々な実装での共通の構文であるか特定の実装でしか使えないものなのかを極力明記しています。 ## HTML要素 MarkdownはHTMLの上位互換言語として開発されたのでほとんどのHTMLはMarkdownでも使えます。 ```md ``` ## 見出し HTMLの`
`を使用したコード引用は半角スペースで4つ空けるか、
タブを1文字を入れます。
```md
これはソースコード
これもソースコード
```
タブをもう1つ(または半角スペースを追加で4つ)入れればコード引用内で
インデントを出力できます。
```md
my_array.each do |item|
puts item
end
```
バックチック文字 `` ` `` を使用すれば文中でインラインコード引用を出力できます。
```md
太郎は`go_to()`関数は何をするのか知らなかったのだ!
```
GitHub版Markdownでは特別な書き方があります。
````md
```ruby
def hogefuga
puts "Hello world!"
end
```
````
上記はインデントが必要無く、しかも最初の```
の後に
シンタックスハイライトで使用する言語を指定することが出来ます。
## 横罫
横罫(`
`)は間のスペースの有無によらず、3つ以上のアスタリスクまたはハイフンを
挿入することで簡単に引くことができます。
```md
***
---
- - -
****************
```
## リンク
Markdownのよい特徴として、簡単にリンクを入れることができる点があります。
表示するテキストを角括弧 [] 内に記載し、URLを丸括弧 () 内に記載します。
```md
[ここをクリック!](http://test.com/)
```
丸括弧内にクォーテーションにリンクタイトルを追加できます。
```md
[ここをクリック!](http://test.com/ "Test.com へのリンク。")
```
相対パスもリンクできます。
```md
[musicへ](/music/)
```
Markdown は脚注スタイルのリンクを使えます。
```md
[このリンク][link1] から詳細を確認できます。
[更にこのリンク][hogefuga] も見てください!
[link1]: http://test.com/ "Cool!"
[hogefuga]: http://hogefuga.biz/ "Alright!"
```
タイトルはシングルクォートや括弧内に書いてもよいし、全く書かなくてもよい。
脚注はドキュメントのどこに書いてもよく、参照IDもユニークなものなら何でもよい。
リンクテキストをIDとして使用する暗黙命名が使えます。
```md
[これ][] はリンク.
[これ]: http://thisisalink.com/
```
が、これはあまり使用されていません。
### 目次
いくつかのMarkdownの実装では、リストとリンクと見出しを使って目次を作ることができます。
この例では、英文字の見出しを小文字にしたものにハッシュ(`#`)を接頭し、これをリンクID
として使っています。単語間にスペースがある場合はスペースの代わりにハイフン(`-`)を使います。
(この時、いくつかの特殊文字は無視されます。)
```md
- [Heading](#heading)
- [Another heading](#another-heading)
- [Chapter](#chapter)
- [Subchapter ](#subchapter-h3-)
```
それでも、この機能はすべてのMarkdown実装で同じ様に動作する保証がありません。
## 画像
画像はリンクと似た構文を持ち、違いは先頭に感嘆符(`!`)があるところです。
```md
![ここで画像のalt属性を指定できます。](http://imgur.com/myimage.jpg "任意でタイトルを追加できます。")
```
脚注スタイルの書き方もリンクと同じ様に書けます。
```md
![画像のalt属性][myimage]
[myimage]: 画像/への/相対/パス.jpg "ここにタイトルを書きます。"
```
## その他の機能
### 自動リンク
```md
は
[http://testwebsite.com/](http://testwebsite.com/)
と同じ。
```
### メールアドレスの自動リンク
```md
```
### エスケープ文字
```md
私は *この文節をアスタリスクで囲みたいが、* 斜字体にしたくない、なので
こうします: \*この文節はアスタリスクで囲まれています。\*
```
### キーボードのキー
GitHub版Markdwonでは、`` タグを使用してキーボードのキーを表すことができます。
```md
パソコンがクラッシュした?
Ctrl+Alt+Del
を打ってごらん。
```
### 表
表はGitHub版Markdownでしか実装されておらず、少し使いずらいです。
```md
| 行1 | 行2 | 行3 |
| :----- | :------: | -----: |
| 左寄せ | 中央寄せ | 右寄せ |
| ほげ | ふが | ほげ |
```
下記も同じ様に表示されますが…
```md
行1 | 行2 | 行3
:-- | :-: | --:
なんなんだ、この | ゴミコードは | 止めろ
```
## Markdownlint
Markdownでの執筆を簡略化したり、書式を統一するために`Markdownlint`が
作られました。スタンドアローンのツールは[このレポジトリ](https://github.com/markdownlint/markdownlint)で配布されていますし、幾つかのIDEのプラグインを
使用できます。これを用れば、Markdownの検証や可読性を確保できます。
---
## 関連情報
より詳細な情報はJohn Gruberの公式ブログに書かれた[構文解説](http://daringfireball.net/projects/markdown/syntax)とAdam Pritchardの偉大なる[チートシート](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet)を参照してください。
主要な実装については下記を参照してください:
- [GitHub版Markdown](https://docs.github.com/en/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)
- [GitLab版Markdown](https://docs.gitlab.com/ee/user/markdown.html)