Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ngyuki committed May 2, 2013
1 parent 8ac5c27 commit 962e5b3
Showing 1 changed file with 23 additions and 17 deletions.
40 changes: 23 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,24 @@ Markdown ファイルのプレビューを行う .NET アプリです。

### 最新版

- [MarkdownView-0.0.3.zip](https://www.dropbox.com/sh/uwsegrzt5incrxq/d8aVIT8o1Z/MarkdownView/MarkdownView-0.0.3.zip)
- [MarkdownView-0.0.3.zip](http://sdrv.ms/106rku7)


### アーカイブ

- [MarkdownView](https://www.dropbox.com/sh/uwsegrzt5incrxq/ROQbGYXlwN/MarkdownView)
- [MarkdownView - SkyDrive](http://sdrv.ms/18ftDRY)


### アーカイブ(旧)

- [MarkdownView - GitHub](https://github.com/ngyuki/MarkdownView/downloads)


インストール
----------------------------------------------------------------------------------------------------

適当なフォルダにダウンロードした zip ファイルを解凍してください。


動作環境
----------------------------------------------------------------------------------------------------
Expand All @@ -32,15 +38,15 @@ Markdown ファイルのプレビューを行う .NET アプリです。
- Internet Explorer 9
- .NET Framework 3.5

これ以外の環境でも動作するかもしれませんが動作確認していません
これ以外の環境でも動作するかもしれませんが動作確認はしていません


ファイルの開き方
----------------------------------------------------------------------------------------------------

下記のいずれかの方法でファイルを開くことが出来ます。

- ウィンドウにファイルをドラッグアンドドロップする
- アプリのウィンドウにファイルをドラッグアンドドロップする
- アプリのコマンドライン引数にファイル名を指定する


Expand All @@ -51,54 +57,54 @@ Markdown ファイルのプレビューを行う .NET アプリです。
ファイルの更新を監視して自動的に再読み込みします。

### エクスポート
開いているフィアルを HTML に変換して保存します。
開いているファイルを HTML に変換して保存します。

### リロード
ファイルを再読み込みします。自動リロードとは異なりCSS も再読み込みされます
ファイルを再読み込みします。自動リロードとは異なり CSS も再読み込みします

### 関連付けを開く
開いているフィアルを関連付けられたアプリで開きます
開いているファイルを関連付けられたアプリで開きます
エディタとかを関連付けておくと便利です。

### ブラウザで表示
開いているファイルをブラウザで開きます
開いているファイルを HTML に変換してブラウザで開きます

### API
ON にすると Markdown ファイルの変換に WebAPI が使用されます。
**ファイル** メニューの **WebAPI の URL** で WebAPI のURL を設定しておく必要があります。
ファイルメニューのWebAPI の URLで WebAPI のURL を設定しておく必要があります。


CSS ファイルの利用方法
CSS ファイルの利用
----------------------------------------------------------------------------------------------------

アプリのインストールディレクトリの css/ ディレクトリか次の順番で CSS を検索します
アプリのインストール先の css フォルダから次の優先順位で CSS を検索し、最初に見つかった CSS を使用します

1. style.css
2. style.default.css

style.default.css はアプリのバンドルされているため、バージョンアップなどで上書きされます
style.default.css はアプリにバンドルされているため、バージョンアップで上書きされます
独自の CSS を使う場合は style.css を手動で作成してください。


WebAPI の利用方法
WebAPI の利用
----------------------------------------------------------------------------------------------------

### WebAPI の URL

[GitHub Markdown API](http://developer.github.com/v3/markdown/) が使えたかもしれません。
ただしファイルの保存毎に API を呼ぶのですぐにリクエスト上限になります。

[redcarpet-preview](https://github.com/ngyuki/redcarpet-preview) を自分で何処かにホストして使うといいかもしれません
[redcarpet-preview](https://github.com/ngyuki/redcarpet-preview) を自分でどこかにホストして使うといいかもしれません

Heroku でホストしたものがあるので、この URL を設定すればそのまま使うことが出来ます(遅いです)。
Heroku でホストしたものがあるので、この URL を設定すればそのまま使うことが出来ます(ただし遅いです)。

```
http://redcarpet-preview.herokuapp.com/markdown/raw
```

### WebAPI 使用時の CSS
### WebAPI 使用時の CSS ファイル

WebAPI 使用時は通常の CSS とは別の CSS が使用されます。次の優先順位でインストール先の css ディレクトリから読み込みます
WebAPI 使用時は通常の CSS とは別の CSS が使用されます。次の優先順位でインストール先の css フォルダから読み込みます

1. webapi.css
2. webapi.default.css

0 comments on commit 962e5b3

Please sign in to comment.