とあるエンジニアの作業ブログ

マシン環境 作業効率化

MacでAsciiDoc環境構築メモ

投稿日:2019年5月6日 更新日:

MacでAsciiDoc環境を構築した時のメモ。簡単にできると思いきや、思いの外時間がかかったので自分用に。

前提条件と動作環境

前提条件

  • Homebrewがインストールされていること
  • Node.jsがインストールされていること
  • Javaがインストールされていること

動作環境

  • macOS HighSierra 10.13.6
  • ruby 2.3.7
  • Java openjdk version “12.0.1”
  • node v12.1.0
  • npm 6.9.0

やりたいこと

以下のサイトを参考に、AsciiDoc & PlantUMLでテキストベースでUMLを記述し、PDFに出力する環境を構築する。
また、エディタはAtomを使っているのでAsciiDoc用のAtom環境も整える。
参考AsciiDoc と PlantUML と mermaid.js で素敵なテキストベース仕様書ライフ

  • AsciiDocで基本的なマークアップ環境を整える
  • asciidoctor-pdfでPDFエクスポート環境を整える
  • mermaid.jsでUML環境を整える①
  • PlantUMLでUML環境を整える②
  • AtomにAsciiDoc関連のパッケージを追加

AsciiDocもろもろのインストール

AsciiDoc関連のgemのインストール

トラシューしてて必要だと判明したもの。

npmでmermaid関連のライブラリをインストール

トラシューしてて必要だと判明したもの。

Atomにパッケージをインストール

インストールするパッケージは以下の2つ。

  • language-asciidoc ··· AtomをAsciiDocに対応させる
  • asciidoc-preview ··· リアルタイムプレビューできるようにする。command + shift + a でプレビュー

実行方法

HTML出力

PDF出力

オプション 説明
-n HTMLのh1,h2,h3···に対して自動採番する。デフォルト無効。
-a いまいちようわからん。これをつけないとtocが失敗する。
toc 目次を生成。
-r asciidoctor-pdf-cjkやasciidoctor-diagramを使う場合につけるオプション。
-o 出力ファイルを指定。デフォルトは入力ファイル(.adoc)と同じディレクトリ。

トラブルシューティング

Javaのruntimeが無いよエラー

問題

対策

Javaがインストールされていなかった。。。前提事項に書いておきながら忘れてた。ということで、下記サイトを参考にインストール。
参考https://qiita.com/y__ueda/items/049009c38068b1cea4a1
参考https://qiita.com/ringo/items/db58b34dc02a941b297f

asciidoctor-diagramでイメージ生成エラー

問題

対策

mermaid.cliのインストールが足りていなかった模様。

ソースコードハイライター(今回はcoderay)が無いよエラー

問題

対策

coderayがインストールされていなかった。最初、普通にgem installしてもなぜかうまくインストールできなかったが、2回目やったらできた。(ただの勘違い??)
一部のサイトではrbenv gem installとしないとダメってのもあったが、rbenvが入ってなかったのでなんか適当に粘ったらできた;

PlantUMLで謎のpngを出力してエラー

問題

以下のようなpngを出力してPlantUMLがエラーになってた。(標準エラーに出ず、PDFファイルの中身をみたらUMLが描画されておらず下記エラー画像に置き換わってる。)
PlantUMLのエラー

対策

言われた通りGraphvizなるものとインストールする。Homebrewでできるらしい。
Graphvizがなにものかはググればわかる。(Wikipediaに記事がある)

AtomのプレビューがずっとLoading AsciiDocのまま

問題

以下のようにAtomのプレビュー画面のまま固まってしまう。
ずっとLoading

対策

Atomの 環境設定 > コア設定 と進み、「Use Tree Sitter Parser」のチェックボックスを外す。
Tree Sitter Parserとは言語の構文ツリー解析のこと。パッケージに互換性が無いためとのこと。
他の言語で構文解析ツリーを有効化したい場合はいちいち環境設定で変更する必要がある。

-マシン環境, 作業効率化
-,

執筆者:


comment

メールアドレスが公開されることはありません。

関連記事

【備忘】MacのExcelの自分的よく使うけど忘れがちなショートカット

MacのExcelのショートカット備忘録。個人的によく使うけど忘れがちなショートカットのみメモ。(感覚的にWindowsとほぼ同じやつは記載割愛) 作業内容 ショートカット セルの編集モードに入る c …

MAMPを移行したらphpMyAdminが起動しなくなった

古いMacからMAMPを個別に移行したら、phpMyAdminが起動しなくなった。 どうやらMySQLのユーザー/パスワードが不一致になってしまったようだ。 関連して他のエラーも発生したため、一連で対 …

クラウドストレージ比較 〜Dropbox、iCloud、Adobe CC〜

Mac新調に伴い、ローカルストレージが256SSDになってしまったので、ローカル保存を極力排除しクラウドストレージへの移行を検討。 ざっくり必要な要件は以下。 メインマシンはMacだが、Windows …

【備忘】gitのglobal userとlocal user使い分け

Macで初めてgit commitした時に、「お前は誰だ?」的な感じで怒られた。

でユーザー名とメールアドレスを指定する必要があるらし …

MacでのAdobeクラウドストレージ活用と作業用ディレクトリ

最近Macを買い換えた。新しいMacはStorageを256にしたのでローカルにバンバンファイルを保存するのには不安が残る。 そこで、これを機に本格的にローカルへのファイル保存をやめて、全てクラウドス …