# マークダウンの書き方 # マークダウンとは? Markdown(マークダウン)は、文章のフォーマットです。 ファイルの形式(拡張子)は、`ファイル名.md` 構造を保持しつつ、装飾をほぼ排除しているのが特徴。 構造と装飾を分離しているため、以下のメリットがある。 - 手軽に**文章構造を明示**できること (装飾の情報がないから) - 文章執筆に集中できる。(装飾は後で調整できるから) - サイト横断でスタイルを変えたいとなった場合でも、各文章はそのまま。(装飾だけ編集すればいいから) - 執筆者によって、表示のアウトプットの質がぶれない(装飾が分離されているから) ちなみにこの文章自体もマークダウンで記載されています。 # マークダウンの書き方 マークダウンは、実質はただのテキストファイルなので、 好きなテキストエディタで作成・編集可能🙆🏻‍♂️ 基本的には、wordとかで文章を記載するのと同じ。 ただ、wordで言うツールバー的なものは存在しないので、 段落、表の挿入、文字の太字化などを、一定のルールで文字として記載することになります。 このルールを、`マークダウン チートシート` の章にまとめてあります。 ※ 覚えなくて大丈夫で、(頻出する用法は嫌でも覚えてしまうので) 逆引き的に使用してもらうのがいいと思います。 各ルールについては、以下の構成になっています。 - ルール名 - 形式 - 文字としてどうやって記載するか - 表示 - 実際どういう見た目になるか # マークダウン チートシート - 見出し - 箇条書き - 段落 - 文字装飾 - 画像 - テーブル - 区切り線 ## 見出し ### 形式 ``` # 見出し1 ## 見出し2 ### 見出し3 #### 見出し4 ##### 見出し5 ###### 見出し6 ``` ### 表示 # 見出し1 ## 見出し2 ### 見出し3 #### 見出し4 ##### 見出し5 ###### 見出し6 ## 箇条書き ### 形式 ``` - 犬 - チワワ - ダックスフンド - ミニチュアダックスフンド - カニンヘンダックスフンド - ペキニーズ - ・・・ - 猫 ``` ### 表示 - 犬 - チワワ - ダックスフンド - ミニチュアダックスフンド - カニンヘンダックスフンド - ペキニーズ - ・・・ - 猫 ## 順序付きリスト ### 形式 ``` 1. 肉と野菜を一口大にきります。 2. フライパンにサラダ油をひいたら中火で肉を炒めます。 3. 野菜を加え、たまねぎが透き通るくらいまで炒めます。 4. 水を加えて15〜20分煮込みます 5. カレールーを加えて完全に溶かしながら10分煮込んで完成です。 ``` ### 表示 1. 肉と野菜を一口大にきります。 2. フライパンにサラダ油をひいたら中火で肉を炒めます。 3. 野菜を加え、たまねぎが透き通るくらいまで炒めます。 4. 水を加えて15〜20分煮込みます 5. カレールーを加えて完全に溶かしながら10分煮込んで完成です。 ## 段落 ### 形式 ``` あのイーハトーヴォのすきとおった風、夏でも底に冷たさをもつ青いそら、うつくしい森で飾られたモリーオ市、郊外のぎらぎらひかる草の波。 (一行以上あけると、段落が変わります。) またそのなかでいっしょになったたくさんのひとたち、ファゼーロとロザーロ、羊飼のミーロや、顔の赤いこどもたち、地主のテーモ、山猫博士のボーガント・デストゥパーゴなど、いまこの暗い巨きな石の建物のなかで考えていると、みんなむかし風のなつかしい青い幻燈のように思われます。 > `>` を使うと引用形式になります。 > では、わたくしはいつかの小さなみだしをつけながら、しずかにあの年のイーハトーヴォの五月から十月までを書きつけましょう。 ``` ### 表示 あのイーハトーヴォのすきとおった風、夏でも底に冷たさをもつ青いそら、うつくしい森で飾られたモリーオ市、郊外のぎらぎらひかる草の波。 (一行以上あけると、段落が変わります。) またそのなかでいっしょになったたくさんのひとたち、ファゼーロとロザーロ、羊飼のミーロや、顔の赤いこどもたち、地主のテーモ、山猫博士のボーガント・デストゥパーゴなど、いまこの暗い巨きな石の建物のなかで考えていると、みんなむかし風のなつかしい青い幻燈のように思われます。 > `>` を使うと引用形式になります。 > では、わたくしはいつかの小さなみだしをつけながら、しずかにあの年のイーハトーヴォの五月から十月までを書きつけましょう。 ## 文字装飾 ### 形式 ``` - *イタリック* - _イタリック_ - **太字** - __太字__ - ***イタリックx太字*** - ___イタリックx太字___ - ~~取り消し線です~~ ``` ### 表示 - *イタリック* - _イタリック_ - **太字** - __太字__ - ***イタリックx太字*** - ___イタリックx太字___ - ~~取り消し線です~~ ## リンク ### 形式 ``` [リンクのテキスト](リンクのURL) ``` ``` カタンについての詳しい情報は、[こちら](https://ja.wikipedia.org/wiki/)から確認できます。 ``` ### 表示 カタンについての詳しい情報は、[こちら](https://ja.wikipedia.org/wiki/%E3%82%AB%E3%82%BF%E3%83%B3%E3%81%AE%E9%96%8B%E6%8B%93%E8%80%85%E3%81%9F%E3%81%A1)から確認できます。 ## 画像 ### 形式 ``` ![画像のalt](画像のURL) ``` ### 表示 ![moderart](https://images-na.ssl-images-amazon.com/images/I/713YlZm9DGL._AC_SL1125_.jpg) ## テーブル ### 形式 複雑なので覚えなくて大丈夫。 [**テーブル作成サイト**](https://notepm.jp/markdown-table-tool)を使うと簡単に作成できる。 ``` N列xM行の表 | ヘッダー 1 | ヘッダー2 | ... | ヘッダー N | | ---- | --- | --- | ---- | | 1行目 | 1-2 | ... | 1-N | | 2行目 | 2-2 | ... | 2-N | | 2行目 | ... | ... | ... | | M行目 | M-2 | ... | M-N | ``` ``` | No | 都道府県 | 人 口 | 市町村数 | | :-: | -------- | ---------: | -------: | | 1 | 東京都 | 13,942,856 | 39 | | 2 | 神奈川県 | 9,200,166 | 33 | | 3 | 大阪府 | 8,823,453 | 43 | | 4 | 愛知県 | 7,552,873 | 54 | | 5 | 埼玉県 | 7,337,330 | 63 | ``` ### 表示 | No | 都道府県 | 人 口 | 市町村数 | | :-: | -------- | ---------: | -------: | | 1 | 東京都 | 13,942,856 | 39 | | 2 | 神奈川県 | 9,200,166 | 33 | | 3 | 大阪府 | 8,823,453 | 43 | | 4 | 愛知県 | 7,552,873 | 54 | | 5 | 埼玉県 | 7,337,330 | 63 | ## 区切り線 `---` と打つと区切り線を表示できる ---