はじめに

前提条件

Go 1.21 以上
Git（差分ビルド機能を使う場合）

インストール

go install github.com/bmf-san/gohan/cmd/gohan@latest

インストールを確認します:

gohan version
# gohan v1.0.0 (commit: abc1234, built: 2024-01-01T00:00:00Z)

ソースからビルド

git clone https://github.com/bmf-san/gohan.git
cd gohan
make install

バイナリダウンロード

GitHub Releases から各プラットフォーム向けのビルド済みバイナリをダウンロードできます。

最初のサイトを作る

ステップ 1: プロジェクトをスカフォールドする

gohan init myblog
cd myblog

次の構造が生成されます:

myblog/
├── config.yaml
├── README.md
├── archetypes/
│   ├── page.md
│   └── post.md
└── content/
    ├── pages/.gitkeep
    └── posts/.gitkeep

サイトタイトル・base URL などは config.yaml を編集してカスタマイズしましょう。全フィールドの詳細は Configuration を参照してください。

ステップ 2: 最初の記事を作成する

gohan new --title="Hello, World!" hello-world

content/posts/hello-world.md が作成されます。編集して本文を追加しましょう:

---
title: Hello, World!
date: 2024-01-15
slug: hello-world
tags:
  - go
  - blog
categories:
  - tech
draft: false
description: はじめての gohan ブログ記事
---

# Hello, World!

**gohan** でブログを始めました！

ステップ 3: テーマテンプレートを作成する

mkdir -p themes/default/templates

themes/default/templates/index.html:

<!DOCTYPE html>
<html lang="{{.Config.Site.Language}}">
<head>
  <meta charset="UTF-8">
  <title>{{.Config.Site.Title}}</title>
  <link rel="stylesheet" href="/assets/style.css">
  <link rel="alternate" type="application/atom+xml" href="/atom.xml">
</head>
<body>
  <header>
    <h1><a href="/">{{.Config.Site.Title}}</a></h1>
  </header>
  <main>
    <ul>
      {{range .Articles}}
      <li>
        <span>{{formatDate "2006-01-02" .FrontMatter.Date}}</span>
        <a href="/posts/{{.FrontMatter.Slug}}/">{{.FrontMatter.Title}}</a>
      </li>
      {{end}}
    </ul>
  </main>
</body>
</html>

テンプレートの詳細はテンプレートガイドを参照してください。

ステップ 4: アセットを追加する（任意）

mkdir -p assets
cat > assets/style.css << 'EOF'
body { font-family: sans-serif; max-width: 800px; margin: 0 auto; padding: 1rem; }
a { color: #0066cc; }
EOF

ステップ 5: サイトをビルドする

gohan build

public/ ディレクトリにサイトが生成されます:

public/
├── index.html
├── sitemap.xml
├── atom.xml
├── posts/
│   └── hello-world/
│       └── index.html
└── assets/
    └── style.css

ステップ 6: 開発サーバーで確認する

gohan serve
# http://127.0.0.1:1313 でプレビュー

ファイルを保存するたびにブラウザが自動でリロードされます。

よくある操作

記事の下書き

draft: true を設定した記事はビルドに含まれません:

---
title: 作成中の記事
draft: true
---

差分ビルド

2 回目以降のビルドは自動的に差分ビルドになります:

gohan build          # 初回: フルビルド
# content/ を編集
gohan build          # 2 回目: 変更分のみ再生成
gohan build --full   # 強制的なフルビルド

推奨 `.gitignore`

public/
.gohan/
gohan

次のステップ

設定リファレンス — すべての config.yaml オプション
テンプレートガイド — テーマのカスタマイズ
タクソノミーガイド — タグ・カテゴリーの管理