YAML de Markdown

宮崎在住エンジニアのジョウ(@JotarO_Oyanagi) です。

API ドキュメントを作成していて「swagger とか ReDoc でテーブル使いたいけど、どうすればいいんだろ」となってあれこれ探した結果、以下の方法で YAML で Markdown 記法が使えるのがわかったのでメモします。

description: | を使う

こういうことです。

...
description: |
  見出し：
  # テキスト

  イタリック：
  *テキスト*

  ボールド：
  **テキスト**

  モノスペース：
  `テキスト`

  罫線：
  ---

  箇条書き：
  * その１
  * その２
  * その３

  番号付きリスト：
  1. その１
  2. その２
  3. その３

  リンク：
  [テキスト](https://example.co.jp) 

  画像：
  ![ロゴ画像](https://img.co.jp/logo.png)


  コード：（`` を ``` に置き換えてください）
  ``
  function() {
    return true;
  }
  ``

  テーブル：
  | 見出し１ | 見出し２ |
  | ---- | ---- |
  | データ１ | データ２ |

これで API ドキュメントづくりが捗りますね！