GitHub markdown API で Markdown をプレビューしてくれる grip を使って
prmd から出力したドキュメントを表示します

Prmd とは？

Prmd は JSON Schema の scaffold, 正当性チェック, ドキュメント生成を行うツールです。
詳しくは下記の記事を参照してください

Rubyの prmd gem でYAMLのスキーマバリデーションをする

grip とは？

ローカル環境でGitHubのREADMEを表示するためのコマンドラインツールです。
README以外も表示可能です。

インストール

Python

$ pip install grip

Brew

$ brew install grip

サンプル

以下の記事で作成した Markdown を表示してみます

Rubyの prmd gem でYAMLのスキーマバリデーションをする
Prmd は JSON Schema の scaffold, 正当性チェック, ドキュメント生成を行うツールです。

コード

schema.md

## <a name="resource-person">Person</a>

Stability: `prototype`

人

### Attributes

| Name | Type | Description | Example |
| ------- | ------- | ------- | ------- |
| **age** | *string* | age of person<br/> **pattern:** `^[0-9]{1,3}$` | `"example"` |
| **name** | *string* | name of person | `"example"` |

実行

$  grip schema.md
 * Running on http://localhost:6419/ (Press CTRL+C to quit)

$ open http://localhost:6419/schema.md

外部資料

joeyespo/grip