aozorahack / aozora2html

Creative Commons Zero v1.0 Universal
14 stars 2 forks source link
aozorabunko aozorahack

Aozora2Html

Build Status Gem Version Code Climate

青空文庫の「組版案内」で配布されている txt2html内にあるt2hs.rbを改造するプロジェクトです。

動作環境

Ruby 3.0以上が推奨ですが、2.7.xでも動くはずです。

それ以前のRuby 2.xで利用する場合は、aozora2html-2.0.xをご利用ください。

インストール

RubyGemsとしてインストール可能になっています。

$ gem install aozora2html

ソースからインストールするときは以下のようにします。

$ gem install bundler
$ rake install

実行

コマンドはaozora2htmlです。以下のように実行します。

$ aozora2html foo.txt foo.html

こうすると、青空文庫記法で書かれたfoo.txtfoo.htmlに変換します。

また、青空文庫サイトで配布している、中にテキストファイルが同梱されているzip形式のファイルも変換できます。

$ aozora2html foo.zip foo.html

第1引数にURLを指定すると、そのURLのファイルをダウンロードして変換します。

$ aozora2html http://example.jp/foo/bar.zip foo.html

第2引数を省略すると、ファイルではなく標準出力に変換結果を出力します。

$ aozora2html foo.txt

コマンドラインオプションとして--gaiji-dir--css-files--use-jisx0213--use-unicode--error-utf8があります。

可能な限り数値実体参照を使って表示するには、以下のようにオプションを指定します。

$ aozora2html --use-jisx0213 --use-unicode foo.txt

テスト

テストも追加しています。テストは以下のように実行します。

$ bundle install
$ rake test

更新履歴

主な更新履歴はCHANGELOG.mdにあります。

コードについて

コードに関する技術的なnoteはHACKING.mdにあります。

License

CC0

CC0

To the extent possible under law, 青空文庫 has waived all copyright and related or neighboring rights to txt2xhtml. This work is published from Japan.