markdown-server/README.md

What is 'markdown-server' ?

MarkdownをHTML化してtext/html形式でレスポンスするシンプルなWebアプリケーションです。Markdown EngineはGithub flavored Markdownです。

How to use

Runtime Environment

python実行環境が必要です。

Library Dependencies

packages_requirements.txtを参照してください。 主に下記ライブラリに依存しています。

No.	Name	Description
1	markdown	Markdown -> HTML 変換ライブラリ
2	pygments	シンタックスハイライト用
3	bottle	Webアプリケーションフレームワーク

Just try

サーバを起動して実行結果を確認する為に、特別な準備は何も必要ありません。 下記コマンドを実行するだけでサーバが起動します。

$ git clone https://github.com/ohbarye/markdown-server
$ cd markdown-server
$ pip install -r packages_requirements.txt
$ python start_server.py

サーバが起動したら下記アドレスにアクセスし、サンプルMarkdownファイルの変換結果を確認してみてください。

$ open http://localhost:8009/sample.md

Do as you like

• markdown-server はresources/markdownディレクトリに配置されたMarkdownファイルに対し、http://host/[file_name]の形式でルーティングを提供します。任意のファイルを置いてください。

• 変換されたファイルはresources/htmlディレクトリに配置されます。生成されるHTMLファイルにCSSも組み込まれているので配布も容易です。

• ホスト名やポート番号などの環境変数はenv.pyにまとめています。適宜変更してください。

ms_port        = '8009'
ms_host        = 'localhost'

• デフォルトの Markdown Engine はGithub flavored Markdownです。異なるスタイルを適用したい場合は好みに応じてCSSファイルを差し替え、env.pyを編集してください。

css_name       = 'github.css'
markdown_type  = 'gfm'