From 8ac5c27aa449fff0461cb57604a8ce5264fe459b Mon Sep 17 00:00:00 2001 From: tsyk goto Date: Wed, 1 May 2013 20:49:27 +0900 Subject: [PATCH] update README.md --- README.md | 108 +++++++++++++++++++++++++++++++++++++++++------------- 1 file changed, 83 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index e8a41c2..be3eac1 100644 --- a/README.md +++ b/README.md @@ -1,46 +1,104 @@ +MarkdownView +==================================================================================================== + これは何？ -============================== +---------------------------------------------------------------------------------------------------- + +Markdown ファイルのプレビューを行う .NET アプリです。 + + +ダウンロード +---------------------------------------------------------------------------------------------------- + +### 最新版 + +- [MarkdownView-0.0.3.zip](https://www.dropbox.com/sh/uwsegrzt5incrxq/d8aVIT8o1Z/MarkdownView/MarkdownView-0.0.3.zip) + -Markdown 形式のテキストファイルのプレビューを行う .NET アプリです。 +### アーカイブ -[HatenaSharp](https://github.com/ngyuki/HatenaSharp)をコピペして作ってます。 +- [MarkdownView](https://www.dropbox.com/sh/uwsegrzt5incrxq/ROQbGYXlwN/MarkdownView) + + +### アーカイブ(旧) + +- [MarkdownView - GitHub](https://github.com/ngyuki/MarkdownView/downloads) -主要な機能 -============================== +動作環境 +---------------------------------------------------------------------------------------------------- + + - Windows 7 + - Internet Explorer 9 + - .NET Framework 3.5 + +※これ以外の環境でも動作するかもしれませんが動作確認していません + + +ファイルの開き方 +---------------------------------------------------------------------------------------------------- -#### Markdown プレビュー -Markdown 形式で記述されたテキストファイルをプレビュー表示します。 +下記のいずれかの方法でファイルを開くことが出来ます。 -ファイルをフォームにドラッグアンドドロップするか、コマンドライン引数に指定するかで開けます。 + - ウィンドウにファイルをドラッグアンドドロップする + - アプリのコマンドライン引数にファイル名を指定する -#### CSS -アプリのインストールディレクトリの css/style.css が存在すれば CSS として読み込まれます。 -このファイルが無ければ代わりに style.default.css が読まれます。 +主な機能 +---------------------------------------------------------------------------------------------------- -#### 自動リロード +### 自動リロード ファイルの更新を監視して自動的に再読み込みします。 -#### 手動リロード -手動でリロードを行います。自動リロードとは異なり CSS も再読み込みされます。 +### エクスポート +開いているフィアルを HTML に変換して保存します。 -#### エクスポート -HTML を出力します。 +### リロード +ファイルを再読み込みします。自動リロードとは異なり、CSS も再読み込みされます。 ### 関連付けを開く -ファイルに関連付けられたアプリで開きます。 +開いているフィアルを関連付けられたアプリで開きます。 +エディタとかを関連付けておくと便利です。 -エディタとかを関連付けておくといいかもしれません。 +### ブラウザで表示 +開いているファイルをブラウザで開きます。 -### ブラウザ起動 -ブラウザで開きます。 +### API +ON にすると Markdown ファイルの変換に WebAPI が使用されます。 +**ファイル** メニューの **WebAPI の URL** で WebAPI のURL を設定しておく必要があります。 -### WebAPI の呼び出し -組み込み Markdown エンジン以外に WebAPI を呼び出すことも出来ます。WebAPI を使えばシンタックスハイライトとかも余裕です。 +CSS ファイルの利用方法 +---------------------------------------------------------------------------------------------------- -```php -$a = "hogehoge"; -echo $a; +アプリのインストールディレクトリの css/ ディレクトリか次の順番で CSS を検索します。 + + 1. style.css + 2. style.default.css + +style.default.css はアプリのバンドルされているため、バージョンアップなどで上書きされます。 +独自の CSS を使う場合は style.css を手動で作成してください。 + + +WebAPI の利用方法 +---------------------------------------------------------------------------------------------------- + +### WebAPI の URL + +[GitHub Markdown API](http://developer.github.com/v3/markdown/) が使えたかもしれません。 +ただしファイルの保存毎に API を呼ぶのですぐにリクエスト上限になります。 + +[redcarpet-preview](https://github.com/ngyuki/redcarpet-preview) を自分で何処かにホストして使うといいかもしれません。 + +Heroku でホストしたものがあるので、この URL を設定すればそのまま使うことが出来ます（遅いです）。 + +``` +http://redcarpet-preview.herokuapp.com/markdown/raw ``` + +### WebAPI 使用時の CSS + +WebAPI 使用時は通常の CSS とは別の CSS が使用されます。次の優先順位でインストール先の css ディレクトリから読み込みます。 + + 1. webapi.css + 2. webapi.default.css