AsciiDocで文章を書く際に使うプレビュー機能を持つ(拡張機能が存在する)テキストエディターについて2つ紹介します。
- Visual Studio Code
- Atom
※Windows10でのみ確認しています。
Visual Studio Code
Visual Studio Codeには、いくつかAsciiDoc関連の拡張機能があります。
今回インストールする拡張機能を使うことで、このような執筆環境が整います。
手順
1. Visual Studio Code をインストールします。
2. Visual Studio Codeに拡張機能をインストールします。
今回インストールする拡張機能の識別子は、joaompinto.asciidoctor-vscode
です。慣れた方法でインストールしてください。
- コマンドラインでのインストール
code --install-extension joaompinto.asciidoctor-vscode
- 実行結果
PS C:\Users\akinasu> code --install-extension joaompinto.asciidoctor-vscode
Installing extensions...
Installing extension 'joaompinto.asciidoctor-vscode' v2.7.15...
Extension 'joaompinto.asciidoctor-vscode' v2.7.15 was successfully installed.
3. Visual Studio Codeを再起動します。
使い方
1. 拡張子が.asciidoc
または.adoc
のファイルを作成し、Visual Studio Codeで開きます。
※拡張子は.ad
、.asc
でも構いません。
2. ファイルを開いたら、Ctrl + k, v
を入力すると右側にPreviewが表示されます。
実際に、入力してみましょう。入力した内容をリアルタイムにPreviewします。
- 入力例
== レベル 1
Text.
=== レベル 2
Text.
==== レベル 3
Text.
===== レベル 4
Text.
.データ形式はCSV, 各カラム幅は表示域の15% (60 ÷ 4 = 15)
[format="csv",width="60%",cols="4"]
[frame="topbot",grid="none"]
|======
1,2,3,4
a,b,c,d
A,B,C,D
|======
- 出力結果
他にも試したければ、チートシートを参考にお試しください。
他にもいくつか機能があり、詳細は拡張機能の説明文AsciiDocを読んで頂ければと思います。
- Syntax highlight
- code snippets
- HTML、PDF、DocBookへの出力
- 画像の貼り付け
HTMLの出力などはF1
でコマンドパレットを開いてasciidoc
と入力して選択します。
Ctrl + Alt + vで、画像の貼り付けできるのは知りませんでした!便利ですね!
Visual Studio Online
ちなみにAzureサブスクリプションなどが必要みたいですが、こちらでも同じ機能が使えます。
Atom
Atomは、GitHub製のテキストエディターです。
Visual Studio Codeと似たような手順と使い方です。
今回インストールする拡張機能(パッケージ)を使うことで、このような執筆環境が整います。
手順
1. Atomをインストールします。
2. Atomに拡張機能(パッケージ)をインストールします。慣れた方法でインストールしてください。
- コマンドラインでのインストール
apm install asciidoc-assistant
- 実行結果
3. Atomを再起動します。
Atomを再起動すると、ポップアップが出るのでYes
をクリックし、依存関係のあるパッケージを入れます。
使い方
1. 拡張子が.asciidoc
または.adoc
のファイルを作成し、Atomで開きます。
※拡張子は.ad
、.asc
、.adoc.txt
、.txt
でも構いません。
2. ファイルを開いたら、Ctrl + Shift + a
を入力すると右側にPreviewが表示されます(asciidoc-preview
の機能です)。
実際に、入力してみましょう。
Ctrl + vで、画像の貼り付けが出来ます(asciidoc-image-helper
の機能です)。
images
フォルダを掘ってくれますし、ファイル名の付け方も好みです。
おわりに
今回、2つだけですがAsciiDocの執筆環境(テキストエディターの拡張機能)について紹介しました。
ちなみにもうひとつ、AsciidocFXというAsciiDocに特化したエディターを紹介したかったのですが時間切れになりました。
4年前の2016年に使ったときは、理由は忘れたのですが使いづらい印象がありました。
ですが、いまだにアップデートされているようなので改めて使ってみようと思います。