目的
- Markdownの書き方を知る。
この記事のターゲット
- Markdownを書いてみたいが書き方がわからない方
- Markdownの基礎的な記法を知りたい方
- Markdownの書き方を理解するよりとにかく記載してみたい方
※Markdownファイルの作成方法や記入そのものの方法を知りたい方はこちらをお読みください。
※Markdownファイルの編集を行うエディタの導入方法はこちらをお読みください。
押さえておきたいポイント
※実際にドキュメントを作成しないとわからないことも多いため、完全に理解できていなくてもOK！
1. 空行を作りたいときは「Enterキー」を二回続けて押下する。
空行を挿入したい場合は「Enterキー」を二回続けて押下するが三回続けて押下してしまってもプレビュー画面は二回の押下と三回の押下で表示に差はない。
1. 改行は半角スペースを2個入力してから「Enterキーを」押下する。
wordやテキストファイルで文章を改行したい場合は「Enterキー」を押下することで改行することができるが、Markdownでは記入した文字の最後に半角スペースを2個入れてから「Enterキー」を押下する。
1. Markdownファイルの拡張子は「.md」
Markdownファイルの拡張子は「.md」を用いる。普段見慣れない拡張子ではあるが戸惑わなくてOK!
Markdownで作成したサンプルファイル(下記画像)を用いてMarkdown記法の解説を行う。
下記の説明を読んでも理解に苦しむ方は、各項目の「記載例」に書かれているコードをコピーして自分のドキュメント用のテンプレートとしてお使いください。
見出しの書き方
- 見出しは#(シャープ)を用いて表す。
- 6段階でサイズの調整ができる。
- サイズは#(シャープ)の数で調整する。
～見出しの記載例～
# おはよう
## おはよう
### おはよう
#### おはよう
##### おはよう
###### おはよう
～プレビュー画面～
おはよう
おはよう
おはよう
おはよう
おはよう
おはよう
サンプルファイルの見出し部分を楕円で囲った画像を下記に記載する。
斜体と太文字の書き方
※斜体は英数字のみ対応で日本語には非対応
- 太文字で強調したい箇所を*(アスタリスク2個)で囲む。
- 斜体で協調したい英数字を(アスタリスク1個)で囲む。
～斜体と太文字の記載例～
・斜体
*Hello*
・太文字
おはようございます
**こんにちは**
こんばんは
～プレビュー画面～
・斜体
Hellow
・太文字
おはようございます
こんにちは
こんばんは
サンプルファイルの斜体・太文字部分を楕円で囲った画像を下記に記載する。
画像の挿入方法
- 画像までのファイルパスかURLを使用して画像を表示する。
- そのままのファイルサイズで記載したいときは
と記載する。 - サイズを変更して記載したいときは
<img src = "画像のファイルパスかURL" width = "サイズ(%)">と記載する。
～画像の挿入例～
・そのままのサイズで記載したいとき
・サイズを変更して記載したいとき
<img src = "https://1.bp.blogspot.com/-duyiXc9KILE/VJ6XrygMzJI/AAAAAAAAqOk/SsuLdRzZVIo/s800/soccer_ball.png" width = "30%">
プレビュー画面
・そのままのサイズで記載したいとき
・サイズを変更して記載したいとき
サンプルファイルの画像の挿入部分を楕円で囲った画像を下記に記載する。
番号のある箇条書きの書き方
- 行の最初に数字を打ち、数字の後ろに.(ピリオド)を打つ。
- 箇条書きにしたい内容を.(ピリオド)の後ろに半角スペースを一つ入れてから記入する。
- 箇条書きの番号は自動的に振られる。
～番号のある箇条書きの記載例～
・順番通りに箇条書きの番号を入力したとき
1. おはようございます。
2. こんにちは。
3. こんばんは。
・順番に関係なく箇条書きの番号を入力したとき
1. おはようございます。
1. こんにちは。
1. こんばんは。
～プレビュー画面～
・順番通りに箇条書きの番号を入力したとき
- おはようございます
- こんにちは。
- こんばんは。
・順番に関係なく箇条書きの番号を入力したとき
- おはようございます。
- こんにちは。
- こんばんは。
サンプルファイルの番号のある箇条書きを記載した部分を楕円で囲った画像を下記に記載する。
番号のある箇条書きの中に番号のある箇条書きを書く方法
- インデントを利用して箇条書きの中の箇条書きを表現する
- 半角スペース三つのインデントを設けて数字を打ち、数字の後ろに.(ピリオド)を打つ。
- 箇条書きにしたい内容を.(ピリオド)の後ろに半角スペースを一つ入れてから記入する。
- 箇条書きの番号は自動的に振られる。
- インデントさえ意識すれば、記載方法は「番号のある箇条書き」と一緒である。
～番号のある箇条書きの中に番号のある箇条書きの記載例～
1. 日本の挨拶
1. おはようございます。
1. こんにちは。
1. こんばんは。
1. アメリカの挨拶
1. Good morning
1. Hello
1. Good evening
～プレビュー画面～
- 日本の挨拶
- おはようございます。
- こんにちは。
- こんばんは。
- アメリカの挨拶
- Good morning
- Hello
- Good evening
番号のない箇条書きの書き方
- 行の最初に-(マイナス)か、+(プラス)か、*(アスタリスク)を打つ。
- 箇条書きにしたい内容を-(マイナス)か、+(プラス)か、*(アスタリスク)の後ろに半角スペースを一つ入れてから記入する。
- 自動的に-(マイナス)か、+(プラス)か、*(アスタリスク)が・(箇条書きの頭の点)に変換される。
～番号のない箇条書きの記載例～
・マイナス記号で記載する
- おはようございます。
- こんにちは。
- こんばんは。
・プラス記号で記載する
+ おはようございます。
+ こんにちは。
+ こんばんは。
・アスタリスクで記載する
* おはようございます。
* こんにちは。
* こんばんは。
～プレビュー画面～
・マイナス記号で記載する
- おはようございます。
- こんにちは。
- こんばんは。
・プラス記号できさいする
- おはようございます。
- こんにちは。
- こんばんは。
・アスタリスクで記載する
- おはようございます。
- こんにちは。
- こんばんは。
サンプルファイルの番号のない箇条書きを記載した部分を四角で囲った画像を下記に記載する。
番号のない箇条書きの中に番号のない箇条書きを書く方法
- インデントを利用して箇条書きの中の箇条書きを表現する
- 半角スペース二つか四つのインデントを設けて数字を打ち、数字の後ろに.(ピリオド)を打つ。
- 箇条書きにしたい内容を-(マイナス)か、+(プラス)か、*(アスタリスク)の後ろに半角スペースを一つ入れてから記入する。
- インデントさえ意識すれば、記載方法は「番号のない箇条書き」と一緒である。
～番号のない箇条書きの中に番号のない箇条書きの記載例～
- 日本の挨拶
- おはようございます。
- こんにちは。
- こんばんは。
- アメリカの挨拶
- Good morning
- Hello
- Good evening
～プレビュー画面～
- 日本の挨拶
- おはようございます。
- こんにちは。
- こんばんは。
- アメリカの挨拶
- Good morning
- Hello
- Good evening
水平線(区切り線)の書き方
- -(マイナス)か、*(アスタリスク)を三つ連続で打つ。
- マイナスとアスタリスクでは線の見た目が若干異なる。
～水平線(区切り線)の記載例～
---
***
～プレビュー画面～
サンプルファイルの水平線(区切り線)部分を四角で囲った画像を下記に記載する。
文章の途中にあるコマンドやコードを目立たせる書き方
- 目立たせたいコマンドやコード部分を`(バッククオート)で囲む。
- 本記載方法の別名はコード記法 ～文章の途中のコマンドやコードを目立たせる記載例～
シェルスクリプトは`echo`コマンドを用いることで任意の文字列を出力することができます。
～プレビュー画面～
シェルスクリプトはechoコマンドを用いることで任意の文字列を出力することができます。
複数行にわたるコマンド群を目立たせる書き方
- 目立たせたい複数行のコマンド群を```(バッククオート三つ)で囲む。
- 本記載方法の別名はコードブロック記法。
- ブロック内に記載したいコマンドの言語を最初の```の後に記載すると、その言語にあった表示をしてくれる(記載例ではshellを指定している)
～複数行のコマンド群を目立たせる記載例～
``` shell
echo "Good morning"
echo "Hello"
echo "Good evening"
```
～プレビュー画面～
echo "Good morning"
echo "Hello"
echo "Good evening"
サンプルファイルのコードブロック部分を楕円で囲った画像を下記に記載する。
リンクの書き方
- 半角の角括弧の間にリンク先として文章上に表示させたいテキストを記載する。
- 半角の丸括弧の間にリンク先のURLを記載する。
- 半角の角括弧と半角の丸括弧をスペースを空けずに続けて並べる。
～リンクの記載例～
[筆者のQiitaのHOME](https://qiita.com/miriwo)
[筆者のTwitter](https://twitter.com/mirimiripc)
[youtube](https://www.youtube.com/?gl=JP&tab=w1)
～プレビュー画面～
筆者のQiitaのHOME
筆者のTwitter
youtube
サンプルファイルのリンク部分を四角で囲った画像を下記に記載する。
まとめ
- Markdownの基本的な記法を記載した。
- 上記さえ押さえていれば基本的にMarkdownでファイルを記載することができる。
付録
今回説明で使用したサンプルファイルのコードを下記に記載する。
下記をすべてコピーしてエディタに張り付ければサンプルファイルと同じMarkdownファイルが作成できる。
# 熱帯魚の紹介
これから自分の趣味の**熱帯魚**について記載する
I describe *tropical fish*
## 目次
1. 飼育のメリット・デメリット
1. 一日の流れ
1. 用品メーカーリンク
1. ADA
1. GEX
1. コトブキ工芸
1. 水作
1. NISSO
1. Tetra
## 1. 飼育のメリット・デメリット
1. メリット
- 見ていて癒される。
- 種類によっては繁殖が楽しめる。
- 様々な種類の魚、水草を組み合わせて自分だけのオリジナリティを表現できる
1. デメリット
- 光熱費が高くなる。
- コンセントを定期的に新品に交換しないと火災の危険がある。
- 部屋の湿度が高くなる。
---
## 2. 一日のながれ
```
10:00 照明をつける
16:00 酸素の添加を終了
17:00 二酸化炭素の添加を開始
20:30 餌を与える
24:00 酸素の添加を開始
```
## 3. 用品メーカーリンク
[ADA](http://www.adana.co.jp/jp/)
[GEX](https://www.gex-fp.co.jp/fish/index.html)
[コトブキ工芸](http://www.kotobuki-kogei.co.jp/)
[水作](https://www.suisaku.com/products.html)
[NISSO](https://www.mkgr.jp/nisso/)
[Tetra](http://spectrumbrands.jp/aqua/)