OmniMarkupPreviewer.sublime-settings 覚書

``OmniMarkupPreviewer.sublime-settings`` に記載されている
英文コメントの日本語訳。

#server_host, server_port

```json
"server_host": "127.0.0.1",
"server_port": 51004,
```
#refresh_on_modified

更新後の遅延時間をミリ秒単位で指定する。

```json
"refresh_on_modified": true,
"refresh_on_modified_delay": 500,
"refresh_on_saved": true,
```

#browser_command

Web ブラウザプレビュー起動時のユーザ定義コマンド。
例えば OS X で Google Chrome を使用してプレビューを起動する場合は
下記を指定する:

```json
"browser_command": ["open", "-a", "Google Chrome", "{url}"]
```

#html_template_name

User public static ファイルは
``$packages/User/OmniMarkupPreviewer/public/`` へ配置され、
User テンプレートは
``$packages/User/OmniMarkupPreviewer/templates/`` へ配置される。
ブラウザへ組込みテンプレートの再読込みを要求する:

* github
* github-v1

```json
"html_template_name": "github",
```

#ajax_polling_interval

Web ブラウザへ内容の変更を反映する間隔をミリ秒単位で指定する。
ブラウザへ再読込みを要求する。

```json
"ajax_polling_interval": 500,
```

#ignored_renderers

無効化するレンダラーのリストを指定する。大文字、小文字は区別される。
有効なレンダラー:

* “CreoleRenderer”
* “MarkdownRenderer”
* “PodRenderer”
* “RDocRenderer”
* “RstRenderer”
* “TextitleRenderer”

例えば Textile と Pod レンダラーを無効にする場合は下記を指定する:

```json
"ignored_renderers": ["TextitleRenderer", "PodRenderer"]
```

#mathjax_enabled

MathJax を有効にする。
MathJax javascript ライブラリは自動的にダウンロードされ、 
``OmniMarkupPreviewer/public/mathjax`` へインストールされる。
MathJax を動作させる為にブラウザの再読込みが必要となる。

##既知の問題:

コンピュータ / ブラウザの性能によっては動作が遅くなることがある。
下記のオプションを使用して調整することができる:

* [“ajax_polling_interval”](#ajax_polling_interval)
* [“refresh_on_modified”](#refresh_on_modified)
* [“refresh_on_modified_delay”](#refresh_on_modified)

```json
"mathjax_enabled": false,
```

#export_options

エクスポートの設定オプション

```json
"export_options" : {
    "template_name": "github-export",
    "target_folder": ".",
    "timestamp_format" : "_%y%m%d%H%M%S",
    "copy_to_clipboard": false,
    "open_after_exporting": false
},
```

##template_name

[“html_template_name”](#html_template_name) の規則に従う組込みテンプレート:

* github-export
* github-v1-export

```json
"template_name": "github-export",
```

##target_folder

* ”.”: マークアップファイルと同階層のフォルダへ出力する。
* null: システムの一時フォルダへ出力する。

**Note:**

フォルダが存在しない場合はシステムの一時フォルダへ出力される。

```json
"target_folder": ".",
```

##timestamp_format
ファイルのタイムスタンプのフォーマット文字列。

```json
"timestamp_format" : "_%y%m%d%H%M%S",
"copy_to_clipboard": false,
```

##open_after_exporting

既定のブラウザ、または [“browser_command”](#browser_command) で指定したブラウザで開く。

```json
"open_after_exporting": false
```

#renderer_options-MarkdownRenderer

MarkdownRenderer オプション

```json
"renderer_options-MarkdownRenderer": {
    "extensions": ["tables", "strikeout", "fenced_code", "codehilite"]
}
```

##有効な拡張

###公式(Python Markdown)

* “extra”: [“abbr”, “attr_list”, “def_list”, “fenced_code”,
  “footnotes”, “tables”, “smart_strong”] の組合せ。

###[PHP Markdown Extra](http://michelf.ca/projects/php-markdown/extra/)

* [“abbr”](http://packages.python.org/Markdown/extensions/abbreviations.html)
* [“attr_list”](http://packages.python.org/Markdown/extensions/attr_list.html)
* [“def_list”](http://packages.python.org/Markdown/extensions/definition_lists.html)
* [“fenced_code”](http://packages.python.org/Markdown/extensions/fenced_code_blocks.html)
* [“footnotes”](http://packages.python.org/Markdown/extensions/footnotes.html)
* [“tables”](http://packages.python.org/Markdown/extensions/tables.html)
* [“smart_strong”](http://packages.python.org/Markdown/extensions/smart_strong.html)
* [“codehilite”](http://packages.python.org/Markdown/extensions/code_hilite.html)
* [“meta”](http://packages.python.org/Markdown/extensions/meta_data.html)
* [“toc”](http://packages.python.org/Markdown/extensions/toc.html)
* [“nl2br”](http://packages.python.org/Markdown/extensions/nl2br.html)

###3RD PARTY

* “strikeout”: 打消し線拡張シンタックス

```rst
`This ~~is deleted text.~~`
```

* “subscript”: 添字拡張シンタックス

```rst
`This is water: H~2~O`
```

* “superscript”: 上付き文字拡張シンタックス 0

```rst
`2^10^ = 1024`
```

* “smarty” または “smartypants”: Python-Markdown 拡張は
  smartypants を使用して下記の字体を表現する。

  * (“curly”) 引用符
  * 強調 (“em” and “en”)
  * dashes

###参考資料

* http://daringfireball.net/projects/smartypants/
* https://github.com/waylan/Python-Markdown/blob/master/docs/extensions/smarty.txt