はじめに
Markdown 記法とは?
文書を簡潔かつスタイリッシュに記述できる記法。
元々は HTML を楽に記述するために考案されたため、ほとんどのウェブサービス(GitHub, Slack, ブログサービス)では Markdown で書かれた文書をそれぞれの CSS を使ってスタイリッシュな HTML に変換して表示してくれる。
Markdown の良い所
- 構造化された文書を素早く書ける
- 特別なソフトは必要ない
- 普遍的な技術であるため、どんな場でも使える
- 内容とスタイルが分離されている
- HTML を埋め込める
Word のようなソフトを使って見た目と内容を同時に意識しながら編集する必要はない。 1つのソースから複数の見た目の文書を生成できる。
この文書もまた Markdown で書かれている。
チートシート
改行・パラグラフ
改行は 半角スペース二つです。 ここは次の文章です。 次のパラグラフです。
改行は
半角スペース二つです。
ここは次の文章です。
次のパラグラフです。
ヘッディング
# ヘッダー 1 ## ヘッダー 2 ### ヘッダー 3 #### ヘッダー 4 ##### ヘッダー 5
ヘッダー 1
ヘッダー 2
ヘッダー 3
ヘッダー 4
ヘッダー 5
斜体・太字
_斜体_
斜体
**太字**
太字
**_斜体太字_**
斜体太字
箇条書き
- いちご - りんご - メロン * アジ * サバ * マグロ
- いちご
- りんご
メロン
アジ
- サバ
- マグロ
1. コーヒー 2. 牛乳 3. お茶
- コーヒー
- 牛乳
- お茶
リンク
詳しくは[こちら](https://daringfireball.net/projects/markdown/syntax)を参照してください。 URL のみ: <https://daringfireball.net/projects/markdown/syntax> ID を使って参照: [Google][google] [google]: https://google.com
詳しくはこちらを参照してください。
URL のみ: https://daringfireball.net/projects/markdown/syntax
ID を使って参照: Google
画像
![ひまわり畑の写真](https://free-materials.com/adm/wp-content/uploads/2016/07/51a7ce858aa46d0165c6dfdfa4684f72-750x499.jpg)
大きさを調整したい時などは<img>
タグを使う。
<img src="https://free-materials.com/adm/wp-content/uploads/2016/07/51a7ce858aa46d0165c6dfdfa4684f72-750x499.jpg" alt="ひまわり畑の写真" width="50%" ></img>
表
| 番号 | 数学 | 国語 | 英語 | | ---- | ---- | ---- | ---- | | 1 | 67 | 49 | 24 | | 2 | 43 | 68 | 92 | | 3 | 89 | 45 | 62 |
番号 | 数学 | 国語 | 英語 |
---|---|---|---|
1 | 67 | 49 | 24 |
2 | 43 | 68 | 92 |
3 | 89 | 45 | 62 |
区切り線
---
ブロック引用
> この部分は引用です。 > > - Markdown もそのまま適用されます。 > > ネストすることもできます。
この部分は引用です。
- Markdown もそのまま適用されます。
ネストすることもできます。
コード・コードブロック
テキストを標準出力に表示するには`echo <text>`を実行してください。
テキストを標準出力に表示するにはecho <text>
を実行してください。
````markdown
write your code here
````
write your code here
シンタックスハイライトも使用可能。
````markdown
import math def cosh(x): return (math.exp(x) + math.exp(-x)) / 2
````
import math def cosh(x): return (math.exp(x) + math.exp(-x)) / 2
LaTeX
レンダラーがあれば LaTeX もレンダリングできる。 よく使われるレンダラーはMathJaxやKaTeXである。
文章に埋め込む場合は$a = 1$のように`$`で囲みます。 $$ \begin{align} y &= A_1 \exp{(-\frac{t}{\tau_1})} + A_2 \exp{(-\frac{t}{\tau_2})} \\ \frac{dy}{dt} &= - \frac{A_1}{\tau_1} \exp{(-\frac{t}{\tau_1})} - \frac{A_2}{\tau_2} \exp{(-\frac{t}{\tau_2})} \end{align} $$
文章に埋め込む場合は$a = 1$のように$
で囲みます。
VSCode 拡張機能
Markdown All in One
全部入りの拡張機能(keyboard shortcut, ToC, preview and more)
Markdown PDF
Markdown を PDF に変換
Markdown Emoji
preview で絵文字構文をサポート
参考
daringfireball.net (accessed on 2022/09/02)
www.markdownguide.org (accessed on 2022/09/02)