minipage - シンプルな静的ページジェネレータ

( English / Japanese )

Go Test License Go Reference GitHub

minipage は、余計な複雑さを排除し、簡単に使えることを目指した静的ページジェネレータです。Markdown ファイルを手軽に HTML に変換したい方に向いています。

GitHub Pages を使いたいけれど、既存の静的サイトジェネレータは複雑すぎる、あるいは重すぎると感じている方にも、minipage は軽量な選択肢となります。

minipage は、サイドバーやバナーなどの余計な装飾を排した、GitHub 風のすっきりした HTML を Markdown から生成します。1ページずつ生成する方式なので、make などのツールを使って、サイト全体の構成を自由に管理できます。

特徴

インストール

GitHub Releases から

リリースページから、お使いの OS とアーキテクチャに対応する .zip ファイルをダウンロードしてください。

アーカイブを展開し、minipage 実行ファイルを PATH に登録されているディレクトリに配置します。

go install を使う場合(全 OS 対応)

Go を使ってインストールする場合は、次のコマンドを実行してください。

go install github.com/hymkor/minipage@latest

Scoop を使う場合(Windows)

Windows では、Scoop を使ってインストールすることもできます。

scoop install https://raw.githubusercontent.com/hymkor/minipage/master/minipage.json

または、hymkor バケットを追加してからインストールします。

scoop bucket add hymkor https://github.com/hymkor/scoop-bucket
scoop install hymkor/minipage

使い方

minipage {options} SOURCE1 [SOURCE2 ...] > OUTPUT.html

SOURCE には、Markdown ファイルのパスまたはHTML の文字列を指定できます。

minipage は、指定された順番に入力を連結します。動作は cat コマンドに似ています。

オプション

使用例

複数ファイルからの基本的な生成

複数のセクションからなるページを生成する場合:

minipage header.md content.md footer.md > index.html

HTML 文字列を直接渡す

コマンドラインから HTML の断片を直接渡すこともできます。

これは、元の README.md には含めたくないロゴなどの要素を追加する場合に便利です。

入力が < で始まる場合、minipage はそれをファイル名ではなく HTML として認識します。そのため、シェルによるリダイレクトと解釈されないよう、文字列を引用符で囲んでください。

# 先頭の '<' によって、ファイルではなく HTML として認識される
minipage "<img src='logo.png' align='left' width='100' />" README.md > index.html

make との併用

make と組み合わせることで、効率よくサイトを生成できます。

all:
	minipage header.md index.md footer.md > index.html
	minipage header.md about.md footer.md > about.html

使用例

Windows 用コマンドラインシェルである nyagos の Web サイトは、minipage を使って構築されています。

また、minipage 自身のプロジェクトサイト用に、GitHub Pages のコンテンツを生成することもできます。

Makefile

docs:
	"./minipage" -outline-in-sidebar -readme-to-index -title "minipage - Minimal Static Page Generator" README.md > docs/index.html
	"./minipage" -outline-in-sidebar -readme-to-index -title "CHANGELOG" CHANGELOG.md > docs/CHANGELOG.html
	"./minipage" -outline-in-sidebar -readme-to-index -title "CHANGELOG" CHANGELOG_ja.md > docs/CHANGELOG_ja.html

この例では、Markdown のソースファイルから、GitHub Pages で公開するためのシンプルな HTML ページを生成しています。

技術的な詳細

minipage が向いている方

次のような点を重視する方に向けて、minipage は設計されています。

CHANGELOG

作者

hymkor (HAYAMA Kaoru)

ライセンス

MIT License