レ点腫瘍学ノート

Top / pukiwikiカスタマイズ箇所 / 2022

Pukiwiki 1.5.3も無理やりMarkdown記法とPukiwiki記法に両対応させた

pukiwiki markdown

先週Pukiwiki 1.5.3を無理やりMarkdownに対応させたという記事を公開していました。Pukiwiki ではどうしても書き方が馴染めないと言う人が少なくない上にMarkdownエディターはいろいろな優れたアプリがどんどん増えていて自分に合った使いやすいものがかなり選べる状態になっています。そこでPukiwikiもやはりMarkdownを取り込んでいかないといけないと考えていたのでした。Pukiwiki Devでもそのような話題が上がっていたようです(参考リンク)。

pukiwiki markdown もともとpukiwiki 1.5.0を無理やりMarkdown対応したという記事がqiitaにありました。確かにタイトルにあるとおり無理やり腕力でMarkdownにしたものなのでやや強引な感じは否めませんが、非常に興味深いものです。Pukiwikiを無理やりMarkdown記法に変えてみた

しかし、先日公開した無理やりMarkdown対応したPukiwiki-mdは全てのページがMarkdownでしか書けないために不便を感じることもありました。 従来型の書き方を使いたいと言うこともあるからです。 そこで、ページによって2種類の書き方を使い分けることができるような改造しました。さらに、チェックボックスで編集からそのいずれかを採用するかを選ぶことができます。

スクリーンショット

Pukiwiki 1.5.3でMarkdownが使えるチェックボックス

従来からの改良点

なお、今回の改良を有効にするためにpukiwiki.ini.phpに$markdown_safemodeと$use_simplemdeの設定項目が必要です。

/////////////////////////////////////////////////
// Pukiwiki Markdown
// https://github.com/m0370/pukiwiki153_md
// https://github.com/sparksuite/simplemde-markdown-editor/
$markdown_safemode = 1; // Safemode 1:On, 0:Off
$use_simplemde = 1; // simple Markdown editorを使用 1:Enable, 0:Disable

編集画面

チェックボックスでMarkdownにチェックを入れると、Markdown記法で書くことができるようになります。チェックボックスを外していると従来のPukiwiki記法になります。

いずれの記法を選んでいるかは内部的にはテキストファイルに#notemdという偽装プラグインを書くことで区別しています。ページ毎に使い分けが可能になっています。ただし、プレビュー機能はこの使い分けに対応していないため、プレビューボタンを非表示にしています。

Markdown記法でもプラグインが使用可能

従来のPukiwiki記法ではブロックプラグインを使用する場合は行頭に#(シャープ)の記号を付けていました。しかし、Markdownでは行頭の#は見出し記号になりますのでプラグインに使用できません。そこで、!を使っています。インラインプラグインは従来通り&plugin();で記載します。

なお、Markdown parserに本文を投入する関係で複数行プラグインには未対応です。

前回からの改装箇所

既存のPukiwikiからの引っ越しも可能

この、ページ毎に従来のPukiwiki記法とMarkdown記法のいずれかを選んで使い分けることができるという方式で何が有利かというと、既存ページのwikiフォルダはそのままに設定ファイルなどを書き換えれば、今まで使っていたPukiwikiがそのままMarkdownも併用できるようになるという点です。全てのページがMarkdownしか使えないのは全ページの書き換えが必要だったので、新規に設置するPukiwikiにはよくても既存の稼働しているPukiwikiからの引っ越しには不向きでした。

今回の改造では、Pukiwiki記法で使用しているページの保存ファイルは手を加えず、一方でMarkdown記法を指定した保存ファイルには #notemd の偽装プラグインを書き込むようにしています。Pukiwiki記法で書いたページのファイルは手を加えていないと言うことは、wikiフォルダをそのまま移植すればこの新しいPukiwiki 1.5.3-mdでも続きを使い続けることができるということを意味します。

なお、必ずバックアップを取ってから引っ越し作業をしてください。データの消失などには責任を負えませんので、ご使用は自己責任で。タイムスタンプを保持したままPukiwikiを丸ごとバックアップする方法についてはこちらのページもご覧ください。

本家のPukiwikiに比べてまだ残っている課題の機能

ダウンロード

ダウンロードはこちらからどうぞ。設置方法は従来のPukiwikiとほぼ同様です。
ただし、pukiwiki.ini.phpに上記の設定項目を設置するのを忘れないようにしてください。
ライセンスはGPL2。

GitHub - m0370/pukiwiki153_md: Pukiwiki 1.5.3 markdown
Pukiwiki 1.5.3 markdown. Contribute to m0370/pukiwiki153_md development by creating an account on GitHub.
https://github.com/m0370/pukiwiki153_md

動作しないときのチェックリスト

もしうまく動かない時は不具合修正のため、ぜひ問題点をTwitterのほうまでご連絡ください。

追記

pukiwiki 1.5.4バージョンも出来ました。

pukiwiki 以前にPukiwiki 1.5.3も無理やりMarkdown記法とPukiwiki記法に両対応させたという記事を公開していました。今回はそのPukiwiki 1.5.4版です。 Pukiwiki 1.5.3も無理やりMarkdown記法とPukiwiki記法に両対応させたpukiwiki markdown

この記事に対するコメント

このページには、まだコメントはありません。

お名前:

更新日:2022-01-02 閲覧数:852 views.