Qiita 事始め。アカウント登録を済ませ、試しに投稿してみようと編集画面を開いたら、Markdownってなんぞや？となった初心者です。
n番煎じだけど、記事を書くに際して必要となった記法をまとめる。随時追加していく予定。
※参考にさせていただいた記事には、適宜文中または文末にリンクを張っております。
目次
1. テキストの修飾
2. テキストの構造化
3. コンテンツの埋め込み
参考文献
1. テキストの修飾
文字スタイル
**style**と記述すると、styleと太字になる。
このように、特別な記号で文字列を挟むことで、文字スタイルを変更できる。
| 記号 | 効果 | 結果 |
|---|---|---|
| ` | ハイライト | style |
| ``` or ~~~ |
複数行をハイライト (シンタックスハイライト) |
(下記参照) |
| * | 斜体 | style |
| ** | 太字 | style |
| *** | 斜体かつ太字 | style |
| ~~ | 打ち消し線 |
ハイライト記号は、クォーテーション'ではなく、バッククォート` なので注意。
シンタックスハイライト
- 複数行をハイライトしたい場合は、以下のようにバッククォートで囲めば良い。
記述:
```
hoge
fuga
```
結果:
hoge fuga
- また、次のように、記述言語名を指定して書くと
```c:(内容説明)
int main(void){
return 0;
}
```
次のようにハイライトがつけられる。(内容説明)の部分に自由な文字列を入れられる。
int main(void){
return 0;
}
シンタックスハイライト可能な言語については、下記参照。
ノート記法
補足(note)を記述する環境。ノート記法と言うらしい。
:::note
これは情報です
:::
:::note warn
これは注意です
:::
:::note alert
これは警告です
:::
結果:
これは情報です
これは注意です
これは警告です
文字に色をつける
Markdownの仕様として、HTMLタグにも対応している1らしく、
<font color="blue">text</font>
などと記述することで、「 text 」のように色をつけることが可能。
その他HTMLタグの利用
- HTMLタグを使えば、文字にアンダーライン(下線)を引くこともできる。
<ins>アンダーライン</ins>
<u>下線</u> ←こっちはダメっぽい
-
改行タグ
<br>を使用することで、テーブルのセル内やリストの途中で改行が可能になる。 -
コメントアウトのタグ:
<!-- this is a comment -->
を使用することで、記事に表示されないコメント文を書ける。
ページ折りたたみ
2. テキストの構造化
目次生成
見出し
#を文頭に付けると見出しとなる。複数個使うと数に応じて小さな見出しになる。
headline1
↑
# headline1と記述headline2
↑
## headline2と記述headline3
↑
### headline3と記述headline4
↑
#### headline4と記述#headline
↑#headlineと記述 (スペースなし)
ただし、#の末尾にはスペースを入れる必要があるみたい。古い記事の情報と食い違うので調べたところ、2022年から記法の仕様が変更がされているようだ。見出しの仕様変更については公式ヘルプで言及されていた。仕様変更の全般については下記。
リスト (箇条書き)
文頭に- , + , * のいずれかをつけると、番号が付かないリストになる。
- スペースかタブでインデント(字下げ)すると、ネスト(入れ子)になる。半角スペースなら2つ以上必要。
- List1
- list1-1
* list1-2
+ List2
- list2-1
+ list2-2
* list2-2.1
結果:
- List1
- list1-1
- list1-2
- List2
- list2-1
- list2-2
- list2-2.1
番号付きリスト
文頭に「数字+ドット記号+スペース」で番号付きリストになる。
- ネストのためには半角スペース3つ以上。
- 番号は自動的に割り振られるため、数字部分はすべて1などとしておくとリスト項目の追加削除に便利。
1. List1
1. List2
1. list2-1
1. list2-2
1. List3
1. list3-1
1. list3-1.1
結果:
- List1
- List2
- list2-1
- list2-2
- List3
- list3-1
- list3-1.1
テーブル
引用の設定
3. コンテンツの埋め込み
URLリンクの挿入
記事内に、指定したURL(webアドレス)へのリンクを設定する。
urlのみ貼り付け
- urlの前後に空行を入れて貼り付けると、リンク先のページがリンクカードとしてサムネイル付きで追加される。
https://qiita.com/
結果:
- 改行をしないと、サムネイルなしのurl文字列のみの表示となる。
https://qiita.com/
結果:
リンク文字列を指定
[表示文字列](url)で、リンクを設定する文字列を指定できる。
[Qiitaのトップページ](https://qiita.com/)
結果:
リンクを定義し、別途参照
リンクしたいurlを名前付け(ラベリング)することにより、ラベル名を指定することでリンクを記述できる。ラベルの定義は文頭でも文末でも問題ないっぽい。
[qiita]: https://qiita.com/
[Qiita][qiita]への[リンク][qiita2]は[こちら][qiita]です。
[qiita2]: https://qiita.com/
結果:
画像の埋め込み
参考文献
公式ドキュメント