README.md in asciidoctor-nabetani-0.1.2 vs README.md in asciidoctor-nabetani-0.1.3

- old
+ new

@@ -20,15 +20,18 @@ ``` $ gem install asciidoctor-nabetani ``` - ## Usage -TODO: Write usage instructions here +Create PDF from AsciiDoc file with this library like following: +``` +$ asciidoctor-pdf -r asciidoctor/nabetani foobar.adoc -o foobar.pdf +``` + ## Contributing Bug reports and pull requests are welcome on GitHub at https://github.com/nabetani/asciidoctor-nabetani. ## Special Thanks @@ -49,18 +52,14 @@ AsciiDoctor で PDF を作るときに困っていたことをなんとかしたライブラリ。 ### 禁則処理の改善 -`asciidoctor/nabetani/prawn-linewrap-ja` を require すると有効になる。 - prawn の禁則処理を本ライブラリの処理で差し替えることで、禁則処理を改善する。 ### クロスリファレンス -`asciidoctor/nabetani/abstractblock-xreftext` を require すると有効になる。 - AsciiDoc のクロスリファレンスで 従来は |形式名|PDF上の出力例| |:--|:--| @@ -88,12 +87,10 @@ ※ 上記以外はそのまま出力される。 ### horizontal な定義リスト -`asciidoctor/nabetani/horz-dlist` を require すると有効になる。 - horizontal な定義リストで ``` [horizontal, margin-left=20, margin-bottom=10] Foo:: bar Baz Qux:: quux corge @@ -101,12 +98,10 @@ のように指定することで、左マージンと下マージンを指定することができる。 指定する数字の単位は PDF point だと思う。 ### PDF のプロパティ -`asciidoctor/nabetani/pdf-custom-property` を require すると有効になる。 - PDF のファイル情報の「概要」欄の項目を adoc ファイル内に ``` // タイトルを「PDF Title」にする :pdf_title: PDF Title @@ -124,20 +119,11 @@ |pdf_producer|PDF変換|Acrobat Distiller| |pdf_creator|アプリケーション|FrameMaker 6.0| ### PDF のしおり(outline) -`asciidoctor/nabetani/pdf-outline` を require することで有効になる。 - テーマの yaml に ``` bookmark: include-title-page: false ``` と書くと、表紙はしおりにふくまれないようになる。 - - - - - - -