Asciidocで作る最強メモ環境 はじめに

環境が整い使いやすくなったAsciidocでパワフルなメモ環境を構築しましょう！

roppi

1 minute read

Asciidocで作る最強メモ環境 ～ はじめに

Markdownあるある

その１

Markdown形式のメモを書式付きで印刷しようとして、直接印刷できずにイラッとする。

その２

表の記述が地味に面倒。

その3

目次を手で書いている。

Asciidocを使って、上記の不満を解決したパワフルなメモ環境を構築しましょう！

はじめに

Markdownは、ビューワーがあれば簡単に見栄よく表示できるため便利な仕組みですが、 ビューワーのない環境や印刷時には、その利点を活かすことができません。

Markdownと同じような仕組みにAsciidocという物があります。
こちらは、PDF出力ができたりCSVを表として表示するなど、Markdownよりも高機能ですが、 まだMarkdownほど浸透していない印象です。

そこで備忘録を兼ねて、数回に分けて「Asciidocで作る最強メモ環境」を記載していこうと思います。

数年前に比べて、標準で日本語が利用できるようになったり、エディタなどが整い使いやすくなったため、 いままで様子見だった方にもオススメです。

ちなみにこのブログも、Asciidocのテキストから生成しています。 方法についても記載する予定なので、気になった方はチェックしていただければと思います。

メニュー

その１ Asciidoc環境を構築しよう

Windows環境でAsciidocを使用できるようにします。

  1. chocolateyのインストール

  2. rubyのインストール

  3. Asciidoctorのインストール

その２ AtomエディタでAsciidocを使えるようにしよう

AtomエディタでAsciidocを使えるようにします。

  1. Atomエディタのインストール

  2. Atomエディタ用プラグインのインストール

その３ Asciidoc記法になれよう

基本的なAsciidocの記法について紹介します。

その４ AsciidocにPlantUMLやMarmaidを埋め込もう

Asciidoc上にPlantUMLやMarmaidなどの図形生成スクリプトを埋込めるようにします。

  1. Asciidoctor Diagramのインストール

  2. PlantUMLのサンプル（ファイル内埋め込み）

  3. PlantUMLのサンプル（外部ファイル参照）

その５ AsciidocからPDF出力をしてみよう

AsciidocからPDFを出力できるようにします。

  1. Asciidoctor PDFのインストール

  2. AtomエディタからPDF出力をできるようにする

その６ Asciidocから静的サイト生成をしてGithub Pagesに公開しよう

Windows環境でAsciidocから静的サイトジェネレータでHTMLを生成し、Github Pagesに公開します。

  1. Hugoのインストール

  2. Hugoの実行

  3. Githubレポジトリの作成

  4. gh-pagesブランチの作成

  5. gh-pagesブランチへのデプロイ

番外編 Asciidocのコミット時に自動でサイトが更新されるようにしよう

前段6にて手動でGithub Pages にデプロイする作業を自動化します。

comments powered by Disqus