sasaken555/techbook-asciidoctor-starter

Starter Kit to write technical document with Asciidoctor.

techbook-asciidoctor-starter

About

AsciiDoc/asciidoctor-pdfで技術文章を作成するための雛形リポジトリです。

英語と日本語で記述されたAsciiDoc文章からHTML/PDFファイルを作成できます。

Prerequisite

ファイル生成のために、以下のソフトウェアを使用します。
事前にダウンロードし、コマンドを実行できることを確認してください。

• GNU Make

• Ruby

• Bundler

このリポジトリでは以下のバージョンで動作確認を行っています。

$ make -version
GNU Make 3.81

$ ruby -v
ruby 2.7.1p83 (2020-03-31 revision a0c7c23c9c) [x86_64-darwin19]

$ bundler -v
Bundler version 2.1.4

Usage

docs ディレクトリにHTML/PDFを生成するAsciiDoc文章を配置します。

$ ls docs/
sample.adoc

ファイル生成に必要なライブラリを事前にインストールします。

$ make setup
>> Installed all dependencies

PDFファイルを生成しましょう。

$ make pdf
>> Cleanup all PDF.
>> Convert succeeded!
>> Converted files are following.
docs/sample.pdf

コマンド一覧

全てのワークフローは make コマンド経由で実行します。
実行可能なコマンドの一覧は make help で参照可能です。

$ make help
setup           依存ライブラリをインストールする。
clean           生成したHTML/PDFを全て削除する。ファイル生成前にも実行される。
pdf             PDFを生成する。
html            HTMLを生成する。
help            ヘルプを出力する。