WindowsにRubyインストールしてasciidocの使い方を覚える

WindowsにRubyインストールしてasciidocの使い方を覚える

日々の進歩が速いもので、もうmarkdownも欠点があるとか言われだして、、。

じゃあということでasciidocでも勉強してみようかと思ってとりあえずWindowsマシンで環境構築するとこから始めてみます。

まずActiveScriptRubyをインストールします。ruby 2.4.0p0 (2016-12-24 revision 57164) [x64-mswin64_100]をインストールしました。

これでgemコマンドが使えます。

Ruby-2.4 (Administrator) consoleを起動して以下をインストールします。

これで一通り環境はそろいました。asciidocの拡張子はadocです。これをhtmlに変換したりpdfに変換することができます。markdownと違ってハイライトなんかあったりUML図が書けたりと、詳細設計を書いたりするのに使ったりすることも可能です。

適当なエディタで拡張子が.adocのファイルを作ります。文字コードはUTF-8である必要があります。

作成したら保存してasciidoctor ファイル名を実行します。

そうすると、sample.adocに対してsample.htmlが作成されていると思います。

見出し タグ
= h1
== h2
=== h3

テーブル表も簡単に作れます。CSV形式がお勧めです。

これを書いたらUTF-8で保存してasciidoctorコマンドを実行するだけです。

WindowsにRubyインストールしてasciidocの使い方を覚える

こんな感じのhtmlファイルが出来上がります。

目次を作る

ワードのような目次を作りたい場合はtocを指定します。

以下のようになります。rightにしたら右側に目次が表示されます。

WindowsにRubyインストールしてasciidocの使い方を覚える

目次にセクション番号を付ける

これは目次を表示するならつけておいた方が良いです。見栄えが良くなります。

これで以下のようになります。

WindowsにRubyインストールしてasciidocの使い方を覚える

アイコンを出力する

asciidocではアイコンを出力することができます。ここではfontawesomeをCDNで読み込んでいます。

こんな感じになります。

WindowsにRubyインストールしてasciidocの使い方を覚える

PlantUMLを埋め込む

UMLをテキストで書いて画像にすることができます。これがすごいですね。

Graphvizをインストールしておく必要があります。

試しに結城先生のAbstractパターンをクラス図で書いてみます。

クラス図を描く場合は、asciidoc-diagramを使用していますのでコマンドは以下のようにします。

WindowsにRubyインストールしてasciidocの使い方を覚える

これが画像となってhtmlファイルに一発で挿入されるわけですからすごいですね。

VS Codeでasciidocをプレビューする

VS CodeにAsciiDocプラグインを使えばプレビューすることができます。

WindowsにRubyインストールしてasciidocの使い方を覚える

adocの拡張子のファイルを開いて、Ctrl + k,vとタイプすればプレビューされます。

スポンサーリンク
  • このエントリーをはてなブックマークに追加
スポンサーリンク

コメントをどうぞ

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

CAPTCHA