Markdownの記述まとめ

初めに

会社の人から
「情報は発信する人にしか入って来ない。」
と言われ刺さったので、とりあえずqiitaで情報発信していこうかなと。
Outputダイジ。

概要

テスト投稿も兼ねて、すでに何番煎じ煎じかわからないMarkdown + α の書式を紹介。
QiitaやGitHubでも使われ、最近使用する機会が増えたので、Knowledge も兼ねて。

コメントアウト

HTML形式でのコメントアウトも可能。
正直HTML形式の方が使いやすい。(私の場合)

Markdown書式

[](コメント内容)
[](複数行の \
場合は \
バックスラッシュ)

HTML書式

<!-- コメント内容 -->
<!-- 複数行の
場合は
改行するだけ -->

見出し

見出しは以下の書式で、#を使用する。
#の数によって見出しの大きさを変更可能。(最大６個)
多いほど小さくなっていく。

Markdown書式

# 見出し1
## 見出し2
### 見出し3

表示例

見出し1

見出し2

見出し3

強調・斜体・取り消し線

* or _で斜体。
* or _が2つで強調。
~~で取り消し線。

Markdown書式

*ここ*が斜体
_ここ_が斜体
**ここ**が強調
__ここ__が強調
~~ここ~~が取り消し線

表示例

ここが斜体
ここが斜体
ここが強調
ここが強調
ここが取り消し線

引用

Markdown書式

> 引用文
> > 二重引用

表示例

引用文

二重引用

リスト

*or-でリスト形式に表示。
リストの中にリストを作ることも可能。
改行する事で、リストと同じ字下げで記載可能。

Markdown書式

- test
* test
  * test
  - test
- test<br />test

表示例

• test
• test
  • test
  • test
• test
  test

チェックボックス

私の場合、GitHubでよく使う。

Markdown書式

- [ ] チェックなし
- [x] チェックあり
  - [ ] サブリスト

表示例

• チェックなし
• チェックあり
  • サブリスト

リンク

文字列にリンクを張る。

Markdown書式

Qiitaは[こちら](https://qiita.com/)から

表示例

Qiitaはこちらから

表

Markdown書式

| xxx | yyy |
|:----|:----|
| test | test |
| test1 | test1 |

表示

xxx	yyy
test	test
test1	test1

インラインコード

`で囲むと背景色が変わり、見やすい形で表示してくれる。
またコードやコマンドを表示する際は```で囲み、
コードの種類指定とファイル名を記載することができる。
(インラインコードの中で```を記載できない。。。)

Markdown書式

`` 文字列 ``

``bash:hello-world.sh
#!/bin/bash
echo "Hello World!!"
``

表示例

文字列

hello-world.sh

#!/bin/bash
echo "Hello World!!"

ちなみにインラインコード内で`を表示したい場合は、
より多くの`で囲む。

改行

HTMLを少しでも触ったことがある方であれば「常識でしょ。」となるかもしれないが一応。
地味に使っている。

HTML書式

改行をする方法です。<br />参考までに。

表示例

改行をする方法です。
参考までに。

折りたたみ

記載内容を折りたたんで表示・非表示を切り替えることを可能にする。
(HTMLですが。。。)

<details>
  <summary>表示文字</summary>
  ここに内容を記載
</details>

表示文字

ここに内容を記載

あとがき

ちょっとわかりにくいところ等あるかもしれませんが、参考になれば。
内容が間違っていたり、Typo等あればひっそりと修正します。
不足情報があれば追記もする予定。