Markdown記法について調べる機会があったので、後学のためにまとめておく。
1. markdown記法とは何か
・軽量型マークアップ記法
マークアップ記法：HTMLやXMLなど、タグで囲むことで文書ファイルの内容を意味付けする記法。 https://wa3.i-3-i.info/word1578.html
・2004年にJohn Graber氏の個人開発により開始されたツールに由来する。
Markdown is a text-to-HTML conversion tool for web writers. Markdown allows you to write using an easy-to-read, easy-to-write plain text format, then convert it to structurally valid HTML.
マークダウンは、ウェブライターのための、テキスト-HTML変換ツール。マークダウンを使うことで、読みやすく書きやすいプレーンテキスト形式で書き、これを構造的に正しいHTMLへ変換することができる。
(https://daringfireball.net/projects/markdown/)
・現在、複数の方言が登場している。どうやらCommonMarkが主流のようで、GitHubでも、このCommonMarkを拡張したGHM(GitHub Flavored Markdown)が採用されている。ちなみにVSCodeはGFMに対応していないらしく、一部の文法が正しく解釈されない模様。(https://qiita.com/tomoki1207/items/44c7959c4381b20b8c11)
・Markdownパーサー：当該記法で書かれたテキストを解釈して、HTMLなどに変換するプログラム。つまりこれ毎に方言があるらしい。
2. 基本的な文法
-
見出し
'# 見出し' '#' + '半角スペース'
-
太字
** +'文字'+ ** (半角スペースなし)
太字
-
斜体
'* + '斜体' + *' (半角スペースなし)- リスト
'*' + '半角スペース'
- リスト
-
数字付きリスト
'数字' + '.' + '半角スペース'
-
テーブル
'|見出し1|見出し2|見出し3|'
'| :- | :-: | -: |'
'| aaa | bbb | ccc |'
| 見出し1 | 見出し2 | 見出し3 |
|---|---|---|
| aaa | bbb | ccc |
3. VSCodeで利用
プロジェクトの概要を記述するための、README.txt を記載する場合などに利用できる。
4.生成AIのプロンプトへの利用
プロンプトの解析の精度が上がる。
また出力形式の指定ができる。
(個人的には、プロンプトにテーブル形式で情報を渡せるのがかなり便利なように思う。SQLとか吐き出させたいときに使えそう)
https://qiita.com/kouz496/items/adcf8c4dfabf192e1d34
5. 参考
https://qiita.com/ourinhu269/items/af1e2b4d7fb71a78aef3
https://github.github.com/gfm/)https://notepm.jp/blog/6932
https://zenn.dev/akuad/articles/markdown-notes
https://github.github.com/gfm/
https://qiita.com/Qiita/items/c686397e4a0f4f11683d
https://zenn.dev/n_ryosuke/articles/3798c61b8c44df