はじめに
昨日からMarkdownについて学習を始めた。いざ書いてみると驚くほど簡単かつ綺麗にドキュメントを書くことができました。
そこで自分用のメモかつ、Markdown記法の練習として、残します。
目次
1.見出し
2.リスト
2.1 番号付きリスト
2.2 番号なしリスト
2.3 チェックボックス
2.4 nestの仕方
3.太字、斜字、打消し線
4.コードの挿入
5.リンクの挿入
6.引用
7.知っておくと便利なこと
#1.見出し
見出しは先頭に「#+(半角スペース) 」をつけることで記述可能です。
#の数によって見出しの大きさを変えることができ、h6の大きさまで指定できます。
見出しh1
# 見出しh1
見出しh2
## 見出しh2
##2.リスト
1.番号付きリスト
「1. 2. 3.」のように記述してもいいですし、「1. 1. 1.」としても自動的に連番で表示してくれるのでどちらでもいいと思います。
2.番号無しリスト
番号無しリストは「- + (半角スペース)」で記述できます。ただし後ろに何かしらの文字を書かないとつけることができません。
- practice
- workout
- homework
3.チェックボックス
チェックボックスは [(半角スペース)] で記述することができます。
ボックス内にチェックを入れたい場合は,**[x]**とすることで
留意しておく点として、Qiitaだとリストなしでのチェックボックスはできないのですかね。。
To Do
- to do
-
hogehoge
リストなしのチェックボックス↓
[ ] このように表示される
#3. 太字、斜字、打消し線
vs-code のプラグイン(拡張機能)で Markdown Oll in One を入れているとショートカットが使えます。(コマンドはMac環境)
太字 (Cmd + b)
moji
**moji**
斜字(イタリック体) (Cmd + i )
moji
*moji*
打消し線
moji
~~moji~~
#4.コードの挿入
コードの挿入は基本的にはコード部分を ```(バッククォート)3つで括ることです。
```
def Hello():
return "Hello"
```
def Hello():
return "Hello"
また、シンタックスハイライトを付けたい時は、言語名を指定するとその言語にあったハイライトがつきます(対応していない言語もあります)
```python
def Hello():
return "Hello"
```
def Hello():
return "Hello"
よく見かける、左上にファイル名をつけるには、言語名:ファイル名 とします
自分のvs-code だとこれで左上に名前がつかない現象が起きたのですが、なにか原因をわかる人がいましたら教えていただきたいです。。。
```python:practice.py
def Hello():
return "Hello"
```
def Hello():
return "Hello"
#5.リンクの挿入・画像の埋め込み
リンクの挿入は、[リンクテキスト](URL)でリンクをつけることができます。
[YouTude](https://www.youtube.com/?gl=JP)
のように書くと
YouTude
画像の挿入は、で画像を出力できます。
#6.引用
引用には、> をつけます
引用したい部分を > 引用部分 > で囲むことでできます。
>
引用
>>引用の引用
>>>引用の引用の引用
>
引用
引用の引用
引用の引用の引用
#7.知っておくと便利なこと
知っておくと便利なこととして、Markdownでは**「\」**をつけるとそのマークダウンを無効化できます。
\#hogeとすると,#hogeとなります。
改行は、
文字の後ろに半角スペース2個 または <br>で出来ます。
その他また、追記事項があれば適宜追加して書いていきたいと思います。