ITエンジニア/デザイナ向けにオープンソースを毎日紹介

PHDocはPython製のオープンソース・ソフトウェア(MIT License)です。

Wikiエンジンの大きな欠点とも言えるのが編集時のテキストエリアが平凡すぎて編集が面倒ということです。そこでPHDocではMarkdownファイルを共通フォーマットにし、編集はテキストエディタを使う方式を採用しています。


メインページです。普通にMarkdownとして書けます。


式を入れる事もできます。


自由にページを作成できます。日本語ももちろん使えます。

PHDocはPython製のコマンドで、自由にMarkdownフォーマットでファイルを作成したり記述した後、phdoc buildコマンドでHTMLファイルを生成します。その後phdoc serveコマンドでWebサーバが立ち上がってコンテンツが閲覧できる形です。Wikiとは違う気もしますが、使い慣れたテキストエディタでコンテンツが作成できるのはとても楽です。

PHDocとMarkdownエディタを組み合わせればプレビューで概ねの完成形を把握しながらチームや外部の人向けにHTMLで公開するといった使い方が出来るようになりそうです。編集がローカルなのでコラボレーション型ではないですが、Wiki風にコンテンツを公開できる点が面白いです。

また、コンテンツ部分をGit管理したり、MarkdownファイルをPDF化したりと再利用、他の技術との組み合わせも容易なのがPHDocの面白さと言えます。個人用メモに使ったりするのも良さそうですね。

lrem/phdoc

 

MOONGIFTの関連記事

コメント

  • DevRel
  • Com2