Hugo-theme-vivliocli

hugo-theme-vivliocli は、組版PDF出力できるドキュメントサイトを構築するためのHugoテーマです。このテーマでは Vivliostyle CLI を利用することで、サイトの任意のセクションを、表紙・目次・しおり・章番号・ページ番号を含むPDFとして出力できます。

特徴

組版PDF出力

_pdf.mdを配置した任意のセクションを、表紙・目次・しおり・章番号・ページ番号を含む組版PDFとして出力できます（ Vivliostyle CLI により実現）。出力形式には左右ページを使用する書籍スタイルと全ページが同じシンプルスタイルを選択できます。章節番号はMarkdownファイルの階層に加え各ファイルの見出しレベルも考慮して自動で割り当てられます。章節番号の出力レベルや最上位レベルのフォーマット（第X章など）を指定できます。

この User Guide がHugo-theme-vivliocli のサンプルも兼ねています。PDFは こちら 。

セル結合を含む複雑な表の描画

includeショートコードを使えば、Markdown内にcsvファイルを読み込み、複雑な表を簡単に描画することができます。垂直||や水平->のセル結合が可能です。各セルではMarkdown記法を使用できます。表の各列の幅やテキスト整列などのスタイル指定も可能です。

カテゴリ
名称
品種
果物
りんご
紅玉
みかん
  • せとか
  • 甘平
ぶどう
デラウェア

MermaidとMathjaxをサポート

Mermaid と Mathjax により、強力なダイアグラム・チャート・数式描画の機能を利用することができます。

sequenceDiagram Alice->>Bob: Hello Bob. Bob-->>Alice: Hello Alice.
$$ \frac{\pi}{2} = \left( \int_{0}^{\infty} \frac{\sin x}{\sqrt{x}} dx \right)^2 = \sum_{k=0}^{\infty} \frac{(2k)!}{2^{2k}(k!)^2} \frac{1}{2k+1} = \prod_{k=1}^{\infty} \frac{4k^2}{4k^2 - 1} $$

複数エディションのPDF出力

ShowIf / HideIf ショートコードを使用して、特定のエディションでのみ出力されるブロックやファイルを書くことができます。これにより、ディティールが異なる複数エディションのPDFを出力できます。

使用方法

まずは Getting Started を参照してください。

動作環境