|
サイズ: 6511
コメント:
|
サイズ: 5670
コメント:
|
| 削除された箇所はこのように表示されます。 | 追加された箇所はこのように表示されます。 |
| 行 18: | 行 18: |
| Markdown 拡張記法 ----------------- ### GFM ### サードパーティーによる拡張で対応できる。([py-gfm][]) * [記法の拡張](https://help.github.com/articles/github-flavored-markdown) * [独自機能](https://help.github.com/articles/writing-on-github) * [記法チートシート](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) [py-gfm]: https://github.com/dart-lang/py-gfm ### Markdown Extra ### python-markdown に標準で入っている Extension により対応。 * [記法の拡張](http://michelf.ca/projects/php-markdown/extra/) |
|
| 行 29: | 行 51: |
| * python-markdown のエクステンションを格納するためのディレクトリを設け、手軽に記法の拡張を試せるようにした | * python-markdown の Extension を格納するためのディレクトリを設け、手軽に記法の拡張を試せるようにした |
| 行 36: | 行 58: |
| python-markdown は [Extension](http://pythonhosted.org/Markdown/extensions/index.html) で機能を拡張/変更することができる。 これを使って GFM 対応等々の拡張を施す。 |
### py-gfm の導入 ### デフォルトでは入っていないので自前で取得してくる必要がある。 ```console $ git clone https://github.com/dart-lang/py-gfm.git $ cp -a py-gfm/* MoinDir/wiki/data/plugin/parser/markdownext/ ``` |
| 行 40: | 行 69: |
| ### 記法の拡張 ### | ### Extension の登録 ### |
| 行 42: | 行 71: |
| GFM, Markdown Extra を導入したい。 GFM について - [Standard Markdown との違い 1](https://help.github.com/articles/github-flavored-markdown) - [Standard Markdown との違い 2](https://help.github.com/articles/writing-on-github) - [記法チートシート](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) Markdown Extra について - [Standard Markdown との違い](http://michelf.ca/projects/php-markdown/extra/) #### Markdown Extra #### python-markdown にデフォルトで拡張機能が入っているので、有効にするだけでよい。 上記自作パーサーでは `wikiconfig.py` 中でパーサーに渡す引数を設定できるのでそれを利用する。 |
`wikiconfig.py` 中でオプションを設定できる。 |
| 行 62: | 行 75: |
| 'extension': ['extra'] } ``` もちろん、MoinMoin 側のプラグイン自体をいじって直接に引数を渡してやってもよい。 #### GFM #### [py-gfm](https://github.com/dart-lang/py-gfm) を導入する。python-markdown 用の extension. デフォルトでは入っていないので自前で取得してくる必要がある。 適当な場所にレポジトリを clone する。 ```console $ git clone https://github.com/dart-lang/py-gfm.git ``` clone したレポジトリへのパスを `sys.path` に追加して import できるようにする。 例えば、`wikiconfig.py` にそのように追記する。 ```python sys.path.insert(0, 'path/to/py-gfm') ``` さらに、`wikiconfig.py` 等でパーサーに渡す引数を設定する。 ```python markdownargs = { 'extensions': ['gfm'] |
'extensions': ['extra', 'gfm', ], |
| 行 115: | 行 99: |
| 'safe_mode': '設定値' | 'safe_mode': '設定値', |
| 行 120: | 行 104: |
| Pygments用CSS ------------- |
Pygments 用 CSS --------------- |
| 行 124: | 行 108: |
| Code Highlighting に使われている Pygments は MoinMoin 本体でも使われているが、Moin 書式のパーサーから呼ぶ場合と出力される html が異なり、Markdown から使う場合は追加で css が必要となる。 | Code Highlighting に使われている Pygments は MoinMoin 本体でも使われているが、Moin 書式のパーサーから呼ぶ場合と出力される html が異なり、Markdown から使う場合は追加で CSS が必要となる。 |
| 行 127: | 行 111: |
| ### cssを書いて配置 ### | ### CSS を書いて配置 ### |
| 行 129: | 行 113: |
| [pygments 公式にある方法](http://pygments.org/docs/cmdline/)で好みのスタイル用の CSS を出力し、 `./MoinMoin/web/static/htdocs/common/` あたりに入れておく。 | [pygments 公式にある方法](http://pygments.org/docs/cmdline/)で好みのスタイル用の CSS を出力し、 `MoinMoin/web/static/htdocs/common/` あたりに入れておく。 |
| 行 144: | 行 128: |
| 追加した css を全ての場合で読み込むように、`wikiconfig.py` に一行追加する。 | 追加した CSS を全ての場合で読み込むように、`wikiconfig.py` に一行追加する。 |
| 行 147: | 行 131: |
| stylesheets = [('all', url_prefix_static + '/common/pygments.css'),] | stylesheets = [('all', os.path.join(url_prefix_static, 'common/pygments.css')), ] |
MoinMoin で Markdown を使う
Markdown と、拡張記法である Github Flavored Markdown (GFM)、および Markdown Extra を同時に使いたい。また、Markdown では html タグを直接記述することができるが、wiki で許可するには危険なので禁止したい。
また、MoinMoin 独自のリンク記法、埋め込み記法、マクロ、パーサー変更機構を使いたい。
(TODO: マクロとパーサを実装する)
プラグイン機構を備えた Python 用 Markdown パーサー (python-markdown) があり、Markdown から html を生成してくれる。MoinMoin からテキストを流し込むプラグインもあり、制限付きながら MoinMoin で Markdown を扱うことができる。
Markdown 拡張記法
GFM
サードパーティーによる拡張で対応できる。(py-gfm)
Markdown Extra
python-markdown に標準で入っている Extension により対応。
MoinMoin 側プラグイン
既にテキストを python-markdown に丸投げする MoinMoin 側パーサープラグイン (Markdown Parser) がある。これを一部改変して使う。
オリジナルからの変更点
- パーサーに渡す引数を
wikiconfig.py中で指定できるようになった (markdownargs = {'option': 'value', }) - html タグを直接記述できなくするため、デフォルトで html タグをエスケープし普通の文字として表示するようにした (
safe_mode='escape')。この挙動はsafe_modeを明示的に定義すればオーバーライドできる。 - python-markdown の Extension を格納するためのディレクトリを設け、手軽に記法の拡張を試せるようにした
- MoinMoin 独自記法に対応するため、python-markdown 側に独自のエクステンションを追加した
python-markdown の設定
py-gfm の導入
デフォルトでは入っていないので自前で取得してくる必要がある。
$ git clone https://github.com/dart-lang/py-gfm.git
$ cp -a py-gfm/* MoinDir/wiki/data/plugin/parser/markdownext/
Extension の登録
wikiconfig.py 中でオプションを設定できる。
markdownargs = {
'extensions': ['extra', 'gfm', ],
}
参考記事
- MoinMoin で Markdown (Github Flavored Markdown) を使う (tototoshi の日記)
- Python で Github Flavored Markdown をレンダリングする (tototoshi の日記)
その他の拡張
他にもいくつかビルトインの extension が用意されている。
また、他のサードパーティー製 extension もある。
html タグの禁止
パーサーへの引数 safe_mode を適切に設定してやればよい。デフォルトでは許可するようになっている。
上記自作プラグインでは safe_mode=’escape’ をデフォルトとした。
変更するには wikiconfig.py 中で以下のようにする。
markdownargs = {
'safe_mode': '設定値',
}
Pygments 用 CSS
ここまで済めばほぼちゃんとレンダリングされるが、Code Highlighting の色分けがまだうまくいかない。
Code Highlighting に使われている Pygments は MoinMoin 本体でも使われているが、Moin 書式のパーサーから呼ぶ場合と出力される html が異なり、Markdown から使う場合は追加で CSS が必要となる。
CSS を書いて配置
pygments 公式にある方法で好みのスタイル用の CSS を出力し、 MoinMoin/web/static/htdocs/common/ あたりに入れておく。
$ pygmentize -S default -f html > pygments.css
pygments 1.6 では以下のスタイルがデフォルトで使用可能。
['monokai', 'manni', 'rrt', 'perldoc', 'borland', 'colorful', 'default', 'murphy', 'vs', 'trac', 'tango', 'fruity', 'autumn', 'bw', 'emacs', 'vim', 'pastie', 'friendly', 'native']
wikiconfig.py
追加した CSS を全ての場合で読み込むように、wikiconfig.py に一行追加する。
stylesheets = [('all', os.path.join(url_prefix_static, 'common/pygments.css')), ]
これでコードブロックの色分けが動作するようになった。