GitHubではREADMEをはじめとして各種文書を専用の記法からHTMLに変換して表示します。大抵の場合は一つのプロジェクトで一つの記法しか使いませんが、その記法の選定はプロジェクトによって異なります。 今回紹介するGitHub Previewは一つの記法だけでなく、GitHub用のドキュメントをプレビューできるソフトウェアです。

GitHub Previewの使い方

GitHub Previewでは多数のフォーマットに対応しています。こちらはMarkdown。

Textile。

Rdoc。

Org。

Creole。

MediaWiki。

この手のソフトウェアでは一つのフォーマットだけに対応することが殆どでしょう。GitHub PreviewはGitHub上で使える記法を網羅しているので、ドキュメントを書くときに安心して使えるはずです。ただ、各記法は汎用的なもので、GitHub特有の記法には対応していないようです。

GitHub PreviewはRuby製のオープンソース・ソフトウェア（MIT License）です。

GitHub Preview kei-s/github-preview: Instant Preview for GitHub’s README formats