もともとpukiwiki 1.5.0を無理やりMarkdown対応したという記事がqiitaにありました。確かにタイトルにあるとおり無理やり腕力でMarkdownにしたものなのでやや強引な感じは否めませんが、非常に興味深いものです。
Pukiwikiを無理やりMarkdown記法に変えてみた - Qiita
もともと文法のわかりやすさや機能性はpukiwiki記法のほうがMarkdownより優れていると思います。リンクも分かりやすいし、文字色などのスタイリングもpukiwiki記法の方が柔軟です。しかし、世の中はますまずMarkdown記法が使える局面が増えてきています。
Windows/Macを問わずMarkdownを書くためのアプリは増えていますし、iPadなどで文書を書く人にもMarkdown記法は使いやすい書式になっています。もはやMicrosoft OfficeのWordで書かれる文書よりもMarkdownのほうが多いのではないでしょうか。そういう時代ですから、pukiwikiもMarkdownで書ければ良いのになと思っていたのでした。何よりも、MarkdownはTyporaにせよiA writerにせよ自分の使い慣れたライティングソフトで書きやすいのが良い。
そこで、pukiwiki 1.5.0で止まっていたpukiwiki-mdを無理やりMarkdown化をpukiwiki 1.5.3に応用してみることにしました。色々と試行錯誤していますが、まだ十分には動作検証はできていません。それでも、なんとかpukiwiki 1.5.3のMarkdown版として動くところまでは来ました。PHP 7.4で動作しています（1.5.3なのでPHP 8では動きません）。
とりあえずテスト環境では動作していますが、現在動作確認中です。ご使用は自己責任で。 https://github.com/m0370/pukiwiki153_md
#hoge
文章です。
[[FrontPage]]で内部リンクを張れる。
もちろん[ほげほげ](http://example.com)というMarkdownのリンクの書き方もできる。
##リスト
- foo
- bar
##画像を表示(Pukiwikiプラグインが使える)
!ref(テスト/test.jpg)
Markdown parserは何を使っても良いが、今回は erusev/parsedown を使用しています。
https://github.com/erusev/parsedown/wiki/
index.php に を加えておく必要がある。
22-25行目をコメントアウトして書き換える
$body = new Body(++$contents_id);
$body->parse($lines);
return $body->toString();
上記のようになっているところを、下記のように書き換える。
foreach ( $lines as &$line ) {
$matches = array();
if ( preg_match('/^\\!([a-zA-Z0-9_]+)(\\(([^\\)\\n]*)?\\))?/', $line, $matches) ) {
$plugin = $matches[1];
if ( exist_plugin_convert($plugin) ) {
$name = 'plugin_' . $matches[1] . '_convert';
$params = array();
if ( isset($matches[3]) ) {
$params = explode(',', $matches[3]);
}
$line = call_user_func_array($name, $params);
} else {
$line = "plugin ${plugin} failed.";
}
} else {
$line = make_link($line); //この行をコメントアウトしてmake_linkをスキップするとraw HTMLを書けるようになる一方でPukiwiki方式のリンクなどの書式が使えなくなる
// ファイル読み込んだ場合に改行コードが末尾に付いていることがあるので削除
// 空白は削除しちゃだめなのでrtrim()は使ってはいけない
$line = str_replace(array("\r\n","\n","\r"), "", $line);
}
}
unset($line);
$text = implode("\n", $lines);
$parsedown = new \Parsedown(); //Parsedown→ParsedownExtraに変更しても良い
$result = $parsedown ->setBreaksEnabled(true) ->text($text); // ->setBreaksEnabled(true)を付けて改行を可能にしている
return $result;
通常のMarkdownではなくMarkdownExtraにしたい場合は $parsedown = new \Parsedown(); の代わりに $parsedown = new \ParsedownExtra(); としてください。その場合はvendor/erusev/parsedownフォルダにParsedownExtra.phpのファイルも入れておく必要があります。
また、今後Pukiwiki 1.5.4が正式リリースされると思いますので、PHP 8.0の対応を見据えて下記のように書き換えておきます。
- canContain(& $obj) を全て canContain($obj) とする。約10箇所。
- {0}は全て[0]にする。3箇所。
- 181,187,915行目の#は!へ変更しなくてよいみたい。
- #freezeの2箇所を!freezeにする
- 257,258,279,280,545,610行目の#も!へ変更しなくてよいみたい（pukiwiki1.5.0.-mdでも変えずに動作しているよう）
123行目付近の下記の行をコメントアウトして書き換えます。
// $arr = explode("\x08", make_line_rules(htmlsc($string)));
$arr = explode("\x08", make_line_rules($string));
htmlscは、htmlspecialcharsで特殊文字をHTMLエンティティに変換するための内部コードですが、HTMLエンティティに変換してしまうと正しくパースされない部分があります。 また、{0}も1箇所[0]に修正しておく。
78〜93行目のうち下記の行をコメントアウトしておく。
if ($converters === NULL) {
$converters = array(
'plugin', // Inline plugins
'note', // Footnotes
// 'url', // URLs
// 'url_interwiki', // URLs (interwiki definition)
// 'mailto', // mailto: URL schemes
// 'interwikiname', // InterWikiNames
// 'autoalias', // AutoAlias
// 'autolink', // AutoLinks
'bracketname', // BracketNames
// 'wikiname', // WikiNames
// 'autoalias_a', // AutoAlias(alphabet)
// 'autolink_a', // AutoLinks(alphabet)
);
}
上記のautolinkやautoaliasの行をコメントを外すようにすればautolinkが効くようにできますが、Markdown parserと何らかのコンフリクトが生じるかも知れません。
下記のファイルで #author となっている部分を全て !author にする必要がある。
- lib/backup.php
- lib/file.php
- MULTILINEプラグインが正しく引数を読み込めない
- おそらくlib/convert_html.phpに書き加えた31行目付近の if ( preg_match('/^\!([a-zA-Z0-9_]+)(\(([^\\)\\n]*)?\))?/', $line, $matches) ) という部分の正規表現に問題があるが、どのように修正すれば良いのか未解決。
- html.inc.phpのようなMULTILINEが必須のプラグインが動作しないが、markdownはある程度はRAW HTMLが書けるので簡単なHTMLならプラグイン無しで対応できそう。
[[リンク]]という形式の内部リンクは正しく解釈されるが、[[リンクテキスト>リンクURL]]あるいは[[リンクテキスト:リンクURL]]というPukiwiki式の外部リンクは正しく反映されない。- [リンクテキスト] (リンクURL) というMarkdown式の書き方にする必要がありましたが、lib/convert_html.phpの45行目付近に $line = preg_replace('/[(.?)]((https?://[-_.!~*'()a-zA-Z0-9;/?:@&=+$,%#]+)( )?(".")?)/', "[[$1>$2]]", $line); を追記することで（おそらく）解決。
- 個々のプラグインまでは動作検証できていません。
- 改行を反映するかどうかはlib/convert_html.phpの55行目付近で設定変更できる。
- $result = $parsedown->text($text); とすれば行末に半角スペース2つで改行されるオリジナルのMarkdown文法となる。
- $result = $parsedown ->setBreaksEnabled(true) ->text($text); とすれば改行は自動で反映される。
- その他のMarkdown parserに関する設定についてはhttps://github.com/erusev/parsedown/wiki/ のREADMEおよびtutorialに解説されている。
先週Pukiwiki 1.5.3を無理やりMarkdownに対応させたという記事を公開していました。Pukiwiki ではどうしても書き方が馴染めないと言う人が少なくない上にMarkdownエディターはいろいろな優れたアプリがどんどん増えていて自分に合った使いやすいものがかなり選べる状態になっています。そこでPukiwikiもやはりMarkdownを取り込んでいかないといけないと考えていたのでした。
しかし、先日公開した無理やりMarkdown対応したPukiwiki-mdは全てのページがMarkdownでしか書けないために 不便を感じることもありました。 従来型の書き方を使いたいと言うこともあるからです。 そこで、ページ282種類の書き方を使い分けることができるような改造しました。さらに、チェックボックスで編集らんからそのいずれを採用するかを選ぶことができます。
チェックボックスでMarkdownにチェックを入れると、Markdown記法で書くことができるようになります。チェックボックスを外していると従来のPukiwiki記法になります。
いずれの記法を選んでいるかは内部的にはテキストファイルに#notemdという偽装プラグインを書くことで区別しています。ページ毎に使い分けが可能になっています。ただし、プレビュー機能はこの使い分けに対応していないため、プレビューボタンを非表示にしています。
従来のPukiwiki記法ではブロックプラグインを使用する場合は行頭に#（シャープ）の記号を付けていました。しかし、Markdownでは行頭の#は見出し記号になりますのでプラグインに使用できません。そこで、!を使っています。インラインプラグインは従来通り&plugin();で記載します。
- #plugin
- !plugin
- &plugin();
なお、Markdown parserに本文を投入する関係で複数行プラグインには未対応です。
- #notemdというキーワード（偽装プラグイン）が本文にある場合はMarkdown記法で、ない場合はPukiwiki記法でパースします。このため、convert_html.phpを2つのParser（Pukiwiki用とerusev/Parsedown）を本文中に#notemdが含まれているかどうかで区別しています。
- さらに#notemdそのものを消してしまったり書き間違えたりするリスクを減らすため、編集画面などにはこの#notemdは非表示になるようにconvert_html.phpに改装を行いました。
- #notemdが編集画面で非表示になるということは、手動で#notemdと書いてMarkdown記法に切り替えることができなくなることでもあるので、lib/file.phpの1093-1105行目付近およびlib/html.phpの409行目付近および430行目付近に手を入れてチェックボックスでMarkdownかどうかを選択できるようにしました。なお、新規ページ作成での初期設定はMarkdownになるようにしました。
- 本文中に#notemdがあるかどうかでMarkdownのチェックボックスのデフォルト値を振り分けるようにしました。これを行うためにlib/file.phpに内部functionとして（#authorプラグインを参考に）remove_notemd、get_notemdなどのfunctionを新設しました。
- 本家のPukiwikiに比べて無効化している機能
- 複数行プラグインは現在動作させることができません。
- プレビューはPukiwiki記法とMarkdown記法が正しく両方を反映させることができないので、プレビューボタンを便宜上非表示にしています。
- プラグインによっては動作確認が不十分なことがあります。