GFM(GitHub Flavored Markdown)Viewerの導入手順 - M2O-Workshop/Training GitHub Wiki

当ページでは、Python製のGMF_Viewerである『grip』の導入手順と使用方法を記載する。

1.GMFとは

GitHub-Flavored-Markdownの頭文字を採った物。

GitHubのREADME.mdやwikiはMarkdown形式で記述するが、
拡張された記法となっており、GFM/GitHub-Flavored-Markdownと呼ばれている。

基本的なルールは標準のMarkdownに準拠しているが、何点か違いがある。

  • URL表記を自動でリンクに変換。
  • 簡略化したテーブル表記が可能。
  • 絵文字を利用可能。

高機能だが、通常のMarkdownをエミュレートしたビューワー上での表示と
実際にリポジトリにコミットした際の表示が異なる場合も少なくない。

翻訳 GitHub Help - GitHub Flavored Markdown：http://qiita.com/qurage/items/a2f3f52c60d7c64b2e08

2.gripとは

GitHub謹製の markdown API で Markdown をプレビューするオープンソフトウェア。

導入の手軽さに対して、GFMのViewerツールやサービスの中でも再現度は高い。
ファイルの更新を検知し、自動で表示を最新化してくれる。＝F5押下が不要。 Pythonで作成されているが、Eclipse-All-OneはPython環境も含んでおり、流用が可能。

ソースコードもGitHubで公開されている。(https://github.com/joeyespo/grip)

※ただし、GFMのビューワーソフトウェアとしては、 　Git-Hub謹製のテキストエディタである 「Atom」に 　標準で同梱されているMarkdown PreViewも高性能である。

3.gripの導入

コマンドプロンプトを起動し、Eclipse同梱のPythonにパスを通しておく。
一般ユーザーの場合は、管理者権限でプロンプトを起動しておくこと。

> setx /M PATH "%PATH%;C:\eclipse46\python\3"

一度コマンドプロンプトを終了し、再度立ち上げてパスの追加を確認する。 以降は管理者権限ではなく、通常のプロンプト起動（Windowsキー＋R）で問題ない。 
> path
PATH=C:\ProgramData\Oracle\Java\javapath; （中略） C:\eclipse46\python\3;

以下コマンドでgripをインストールする。 資源はWebから自動でダウンロードされるため、ネット接続が必須となる。 
> python -m pip install grip

自動でインストールが進み、「Successfully」の行が表示されれば成功。 
Collecting grip
  Downloading grip-4.3.2.zip (149kB)
  Running setup.py install for grip
  ・
  ・
（中略）
  ・
  ・
Successfully installed Flask-0.11.1 Jinja2-2.8 Markdown-2.6.7 MarkupSafe-0.23 Pygments-2.1.3 Werkzeug-0.11.11 click-6.6 docopt-0.6.2 grip-4.3.2 itsdangerous-0.24 path-and-address-2.0.1 requests-2.12.3
You are using pip version 7.1.2, however version 9.0.1 is available.
You should consider upgrading via the 'python -m pip install --upgrade pip' command.

上記の例のように、末尾にPythonのバージョンに関する警告が表示される場合がある。 「より最新版が利用可能。Updateせよ」の主旨。以下のコマンドでアップデートが可能。 
> python -m pip install --upgrade pip

Eclipseが起動中であれば構成の変更を検知するので、「変更を適用する」を選択して問題ない。

4.gripの起動

以下のコマンドでgripが起動する。事前にmdファイルの格納フォルダにCDしておく。

> python -m grip <mdファイル名>

引数はフルパスでも指定可能なため、CDせずに以下ような指定でも起動可能。 ```dos > python -m grip C:\\ ```
起動すると自動でローカルAPサーバーが立ち上がり、URLが表示される。 ```dos * Running on http://localhost:6419/ (Press CTRL+C to quit) 127.0.0.1 - - [06/Dec/2016 22:58:07] "GET / HTTP/1.1" 200 - ```
ブラウザを立ち上げ上記URLにアクセスしても良いし、以下のコマンドで規定ブラウザが立ち上がる。 プロンプト上で「CTRL+C」を押下すると終了する。 ```dos > start http://localhost:6419/ ``` ***

5.備考

  • ファイル名やパスに空白スペースを含むとPythonが区切り文字と解釈し、エラーとなる。

  • 全角文字を含むファイル名やパスは問題なく動作する。

  • GFMの再現度はほぼ100%だが、絵文字のニュアンスといった細部には差異がある。

  • gripの起動～ブラウザ起動までを*.batファイル化すると２回目以降の起動が容易になる。

  • APIに時間当たりの使用回数制限あり。呼び出しは5000回/時間まで。超過で警告画面に遷移。

6.参考

Pythonの開発環境を整える
http://ichitcltk.hustle.ne.jp/gudon2/index.php?pageType=file&id=python_install.md

Pythonの「Fatal error in launcher: Unable to create process using '"'」でお困りのあなたへ
http://qiita.com/totti_Laziness/items/7a3ecda23572053f8fa6

Grip - GitHub風にMarkdownをHTMLプレビュー
http://www.moongift.jp/2014/01/grip-github%E9%A2%A8%E3%81%ABmarkdown%E3%82%92html%E3%83%97%E3%83%AC%E3%83%93%E3%83%A5%E3%83%BC/

GitHub markdown APIで遊ぶよ http://blog.tojiru.net/article/282553095.html

⚠️ **GitHub.com Fallback** ⚠️