TeamWorking
マークダウン記法
マークダウン記法とは
マークダウンは、テキストを簡単にフォーマットするための軽量マークアップ言語である。主に、プレーンテキストで書かれた文書を HTML やパワーポイント形式などに変換するために使用される。
マークダウン文書の拡張子は通常 .md である。VS Code では、マークダウンファイルを開くと、プレビュー機能が利用できる。プレビューは、エディターの右上にあるプレビューのアイコンをクリックするか、ショートカットキー Ctrl-k v で表示される。
見出し
マークダウンでは、見出しを作成するために # 記号を使用する。# の数によって見出しのレベルが決まる。
# レベル1の見出し
## レベル2の見出し
### レベル3の見出し
#### レベル4の見出し
##### レベル5の見出し
これは次のように表示される。
レベル1の見出し
レベル2の見出し
レベル3の見出し
レベル4の見出し
レベル5の見出し
段落
段落は、空行で区切ることで作成される。段落内のテキストはそのまま書くことができる。
これは段落です。
これは別の段落です。
これは次のように表示される。
これは段落です。
これは別の段落です。
改行
改行は、行末に2つのスペースを入れることで作成される。
これは改行の例です。
改行後の行です。
これは次のように表示される。
これは改行の例です。
改行後の行です。
水平線
水平線は、3つ以上の - を使用して作成する。
---
これは次のように表示される。
なお、マークダウンをスライド作成に使用することがあるが、その場合、水平線はスライドの区切りとして利用される。
リスト
リストは、- や * を使って作成することができる。番号付きリストは数字とドットを使用する。
- 順序無しリストのアイテム
- サブアイテムはタブもしくは4つのスペースでインデントする
- 順序無しリストの別のアイテム
1. 順序付きリストのアイテム
1. サブアイテムはタブもしくは4つのスペースでインデントする
2. 順序付きリストの別のアイテム
これは次のように表示される。
- 順序無しリストのアイテム
- サブアイテムはタブもしくは4つのスペースでインデントする
- 順序無しリストの別のアイテム
- 順序付きリストのアイテム
- サブアイテムはタブもしくは4つのスペースでインデントする
- 順序付きリストの別のアイテム
強調
テキストを強調するためには、アスタリスク * またはアンダースコア _ を使用する。
*強調* もしくは _強調_（斜体として表現されることが多い）
**強い強調** もしくは __強い強調__（太字として表現されることが多い）
これは次のように表示される。
強調 もしくは 強調（斜体として表現されることが多い）
強い強調 もしくは 強い強調（太字として表現されることが多い）
リンクと画像
リンクを作成するには、[表示テキスト](URL) の形式を使用する。画像は同様の形式で、先頭に ! を付ける。
[香川大学のホームページ](https://www.kagawa-u.ac.jp/)
これは次のように表示される。
引用
引用は、> 記号を使用して作成する。
> これは引用です。
> 引用は複数行にわたることもできます。
これは次のように表示される。
これは引用です。
引用は複数行にわたることもできます。
コード
コードブロックは、バッククォート ` を使用して作成する。インラインコードは単一のバッククォートで囲む。
ここに`インラインコード`があります。
次のように表示される。
ここにインラインコードがあります。
コードブロック
コードブロックは、3つのバッククォートで囲むことができる。
```python
print("Hello, World!")
```
すると、次のように表示される。
print("Hello, World!")
最初の3つのバッククォートのあとに言語を指定することで、シンタックスハイライトが適用される。
HTML タグ
マークダウン内で HTML タグを使用することも可能である。例えば、<span> タグを使用して色を変更することができる。
これは <span style='color: red;'>HTML タグ</span>を使用した例です。
これは HTML タグを使用した例です。
エクスポート
マークダウンは HTML や PDF などの形式にエクスポートすることができる。 マークダウンファイルを開いている VS Code のエディターで、右クリックすると、エクスポートのためのメニューが表示される。
（おまけ）スライドの作成
マークダウン記法からスライドを作成することもできる。Marp は、マークダウンからスライド (PDF や HTML など) を生成するためのツールである。また、Marp for VS Code (by Marp team) は、VS Code で Marp を利用するための拡張機能である。
Marp for VS Code をインストールするには VSCode の Extensions（拡張機能）のアイコンをクリックし、検索ボックスに “Marp” と入力して、現れる for VS Code (Marp team) をインストールする。
Marp を使用するためには、スライド用のマークダウンの先頭に次のようなメタデータを記述する。こうすると VS Code のプレビューもスライド形式になる。
---
marp: true
theme: default
paginate: true
---
また、スライドの区切りには --- を使用する。（逆に水平線を表示するには <hr> タグを使う必要がある。）
Marp で作成したスライドを PDF や HTML 形式でエクスポートするには、VS Code のエディターの右上の “Show Quick Pick of Marp Commands” をクリックし、”Export Slide Deck” を選択する。すると、PDF や HTML などの形式でエクスポートすることができる。