ロリポップでMarkdown(拡張子md)ファイルを自動HTML表示させる

シェアする

  • このエントリーをはてなブックマークに追加
  • Evernoteに保存Evernoteに保存

Markdown記法で書かれた(.md)ファイルをGitHubのようにHTMLに変換させる方法

以下は、ロリポップ・サーバ上のマークダウン記法で書かれた拡張子mdのテキストファイルを、GitHubのように自動でHTMLに変換して表示する方法です。他のサーバーでも動作すると思いますが、参考元のページをご覧いただくとわかりやすいと思います。

  1. md形式テキストをHTML変換するPHPクラスを設置する

    PHP Markdown“もしくは”Markdown Parser in PHP“などのMarkdownテキストをHTMLに変換するスクリプトをダウンロードして設置します。ここでは後者を利用しています。(ファイル名は”parsedown.php”で、下記”markdown.php”から呼び出されます)

  2. md形式ファイルにHTMLヘッダおよび変換を行うスクリプトを設置する

    次のスクリプトは.htaccessの設定により”.md”ファイルが開かれると呼び出されるPHPファイルです。呼び出されると、環境変数($_SERVER)から対象となるmdファイルを読み込みHTML形式に変換後、HTMLヘッダを加えて表示するスクリプトです。(ファイル名は”markdown.php”で、次項で説明する.htaccessから呼び出されます)

  3. .htaccessに拡張子”.md”のファイルの挙動を定義する(関連付けさせる)

    .htaccessで、コンテンツ・タイプ”text/markdown”を追加し、拡張子”.md”の関連付けを行ったのち、そのアクションとして上記”markdown.php”を呼び出す設定をする。

  4. CSSファイルを設置する

    プレーンなHTMLで表示されるため、必要であればNormalize.cssや好みのCSSファイルを設置します。

  5. mdファイルを設置して表示を確認する。(mdのサンプル
  6. 最終的なファイル設置

    このサンプルでは下記のように設置していますが、必要に応じてファイル名や設置先、各々のファイルのパスを修正します。

    /.htaccess
    /sample.md
    /path/to/parsedown.php
    /path/to/markdown.php
    /path/to/your/reset.css
    

所感

HTMLを筆頭に、POD記法・TeX記法・はてな記法・マークダウン記法などさまざまなテキストのフォーマット用の記法があります。オープン系のソフトウェア開発では、やはりマークダウン記法がドキュメント類のデファクト・スタンダードで、ソース・コードをダウンロードすると”README.md”といった拡張子mdのファイルを目にすることが多いと思います。

単純にテキストとして開くと、「ふーん」といった感じなのですが、右のようなエディタや、GitHubなどのバージョン管理ツール上ではHTMLに変換され綺麗に表示されます。やはり見栄え重視の場合はHTMLファイルには勝てないのですが、README的なちょっとしたドキュメントや仕様を書く場合にはマークダウン記法がとても便利で生産的なので、GitHubのような動作をロリポップ・サーバーでも実現させたかったのです。


スポンサーリンク
レクタングル(大)広告
レクタングル(大)広告

シェアする

  • このエントリーをはてなブックマークに追加
  • Evernoteに保存Evernoteに保存