テーマの公開用設定
テーマを自作する際は、せっかくなら公開できる形で作り始めましょう。もしかしたら他の人に使ってもらえるかもしれませんし、フィードバックがもらえるかもしれません。
テーマ投稿ガイドラインに従って、必要な手順を整理します。
1. theme.toml を作成する
theme.tomlというファイルは、テーマのメタ情報が含まれたファイルです。こちらは、hugo new themeのコマンドでは自動生成されていません。自分で作成しましょう。
name = 'Theme Name'
license = 'MIT'
licenselink = 'Link to theme's license'
description = 'Theme Description'
homepage = ''
demosite = ''
tags = ['blog', 'company']
features = ['some', 'awesome', 'features']
[author]
name = 'Your Name'
homepage = 'Your Website'
このファイルの内容は、このテーマがどのような特徴を持ち、誰がどんなライセンスで作成しているのかといったものになります。実際にビルドされるサイトにはほぼ影響のない情報ですので、自分だけで使う分には必要ありません。
2. README.md を作成する
README.mdは、GitHubなどで表示されるだけでなくHugo Themesページで公開する際にも使用されます。そのため、画像を追加する場合は絶対パスを使用するようにしましょう。
3. スクリーンショットとサムネイルの画像を用意する
テーマのプロジェクトルートにimagesフォルダを作成し、screenshot.pngとtn.pngという画像を用意しましょう。それぞれスクリーンショットとサムネイル画像で、Hugo Themesページでの公開などに使われます。
どちらもアスペクト比は 3:2 ですが、最小サイズが異なるので注意しましょう。スクリーンショットは 1500 x 1000 px、サムネイルは 900 x 600 pxです。
テーマの雰囲気を伝える顔になるので、完成するまでは仮の画像でもよいでしょう。
4. Hugo モジュール化する
Hugoは、Hugoモジュールという仕組みを使ってコンテンツやレイアウトを管理できます。
この手順はテーマ投稿ガイドラインには記載されていないので必須ではありませんが、再利用や配布がしやすくなるのでやっておいて損はないと思います。
実行にはGo言語が必要です。
hugo mod init github.com/user/theme-name