マークダウン記法【GitHub講座#7】

マークダウン記法【GitHub講座#7】

GitHubの講座は完結したつもりでしたが、マークダウン記法についてもまとめてみることにします。公式文書についてはこちらから確認できます。

マークダウン記法

マークダウン記法のメリットは単純明快な文法です!プログラミングに馴染みのない方でも簡単に覚えられるのが最大の強みですね。

以下では公式ページに載っているマークダウン記法について説明しておきます。

見出し

見出しは頭に『#』をつけるだけです。見出し6が最小サイズ。

# 見出し1(h1タグと同じ)
## 見出し2(h2タグと同じ)
### 見出し3(h3タグと同じ)
#### 見出し4(h4タグと同じ)
##### 見出し5(h5タグと同じ)
###### 見出し6(h6タグと同じ)

強調(装飾)

太字にしたりイタリック体にすることができます。

*イタリック*
_イタリック_
**太字**
__太字__
***イタリック&太字***
___イタリック&太字___
__太字の中の*イタリック*__
~~打ち消し戦~~

リスト

リストの形式は組み合わせることが可能。空白を行頭に入れてあげると階層が表現できます。

Unordered List
* 箇条書き1
* 箇条書き2
  * 箇条書きa
  * 箇条書きb
* 箇条書き3

Ordered List
1. 箇条書き1
2. 箇条書き2
      * 箇条書きa
      * 箇条書きb
3. 箇条書き3

『*』の代わりに『-』を使うこともできます。

- 箇条書き1
- 箇条書き2
- 箇条書き3

画像

![alt属性の文章](画像url)という形式で記述します。alt属性というのは画像が表示されなかった場合にかわりに表示されるテキストになります。

![プロフィール画像](https://avatars.githubusercontent.com/u/45201864?s=64&v=4)

リンク

URLを貼り付けるだけでクリック可能なリンクを作成してくれます。特定のテキストにリンクをつける場合は2行目のように記述するだけ。

https://www.iwachoco.com/wp/
[岩ちょこLab](https://www.iwachoco.com/wp/)

引用

文章
> 引用部

その他

その他便利そうな物をピックアップ。

テーブル(表)

表の1行目と2行目の境界のみ『ハイフン(-)』を用いて区切ります。列の境は『パイプ(|)』を用いて区切ります。ハイフンは3つ以上つける必要があるようです。

下の3×3の表は右揃え、中央揃え、左揃えの指定の仕方になります。

1行1列|1行2列
---|---
2行1列|2行2列
3行1列|3行2列
4行1列|4行2列

名前|特技|戦闘力
:---|:---:|---:
マスオ|ヴォイスパーカッション|100
レオナルドダヴィンチ|ギター|100000

インラインコード

```
function add(a, b) {
    let res = a + b;
}
```

エディタ風にテキストに色をつけてくれる機能。『“`』の後ろに言語名をつけてあげればオッケー。

```javascript
function add(a, b) {
    let res = a + b;
}
```

チェックボックス

チェックマークを入れたい項目には角括弧の中に『エックス(x)』を入れます。リストと一緒に使うこともできます。

- [ ] 未達成の項目
- [x] 達成済の項目

メンション

@の後ろにユーザー名をつけるだけ。

@iwachoco

注釈

hoge hoge[^1]
[^1]: 注釈テキスト

水平線

___

Gist【GitHub講座#6】


最後まで記事を見ていただきありがとうございます。また別の記事でお会いできることを祈っております。

Print Friendly, PDF & Email

GitHubカテゴリの最新記事