Hugoでよく使うコマンド一覧

はじめに

#

静的サイトジェネレータHugoで使用頻度の高いコマンドをまとめた。 Hugoのバージョンは0.79.0/extendedである。

新しいサイトを作る(hugo new site)

#

新しいサイトを作るには、hugo new site <site name>を実行する。実行すると、カレントディレクトリに<site name>と同じ名前のフォルダが作成され、その中にサイトのテンプレートが出力される。

実行例

#

> hugo new site mysite
Congratulations! Your new Hugo site is created in C:\...\mysite.

Just a few more steps and you're ready to go:

1. Download a theme into the same-named folder.
   Choose a theme from https://themes.gohugo.io/ or
   create your own with the "hugo new theme <THEMENAME>" command.
2. Perhaps you want to add some content. You can add single files
   with "hugo new <SECTIONNAME>\<FILENAME>.<FORMAT>".
3. Start the built-in live server via "hugo server".

Visit https://gohugo.io/ for quickstart guide and full documentation.

新しい記事を作る(hugo new)

#

新しいサイトを作るには、hugo new <file path>を実行する。 <file path>はcontentフォルダを基準として、ファイル名も含めて指定する（テーマによって挙動が若干異なるため注意）。

実行例

#

テーマを未導入の場合、content/posts/test.mdというファイルを作るには、以下を実行する。postsフォルダがない場合には、自動的に作成される。

> hugo new posts/test.md
C:\...\content\posts\test.md created

また、同じ名前のファイルが既に存在する場合はエラーを返す（上書きはされない）。

> hugo new posts/test.md
Error: C:\...\content\posts\test.md already exists

プレビュー用の仮想サーバを立ち上げる(hugo server)

#

作成した記事や、サイトのレイアウトをプレビューするためには、hugo serverコマンドを実行する。実行すると仮想サーバが立ち上がるので、ブラウザでアクセスする（デフォルトではhttp://localhost:1313/）。 仮想サーバの起動中にファイルを修正すると、自動的にプレビューも修正される。そのため、リアルタイムプレビューとしても利用できる。 また、hugo serverコマンドでは、PCのメモリ上にプレビュー用データが展開されるだけであり、実際にファイルが生成される訳ではない。ファイルを生成するためには、hugoコマンドを実行する（後述）。

オプション

#

hugo serverコマンドの主なオプションは以下の通り。hugo server -Dのように後ろに付けて実行する。

実行例

#

hugo serverコマンドの実行例を以下に示す。生成されたページ数、生成時間などが表示される。 仮想サーバを停止するためには、Ctrl+Cを押す。もし停止しなければ、長押し（1秒程度）する。

> hugo server
Start building sites …

                   | JA
-------------------+------
  Pages            | 118
  Paginator pages  |   2
  Non-page files   |   0
  Static files     | 132
  Processed images |   0
  Aliases          |  34
  Sitemaps         |   1
  Cleaned          |   0

Built in 9443 ms
Watching for changes in C:\...\mysite\{archetypes,content,data,layouts,static,themes}
Watching for config changes in C:\...\mysite\config\_default
Environment: "development"
Serving pages from memory
Running in Fast Render Mode. For full rebuilds on change: hugo server --disableFastRender
Web Server is available at http://localhost:1313/ (bind address 127.0.0.1)
Press Ctrl+C to stop

公開用のファイルを生成する(hugo)

#

公開用のファイルを生成するには、hugoコマンドを実行する。 実行すると、publicフォルダに公開用のファイル一式(HTML, CSSなど)が生成される。

オプション

#

hugoコマンドの主なオプションは以下の通り。hugo -Dのように後ろに付けて実行する。

バージョンを表示する(hugo version)

#

Hugoのバージョンを表示するには、hugo versionを実行する。

> hugo version
Hugo Static Site Generator v0.79.0/extended windows/amd64 BuildDate: unknown

参考

#

Commands Hugo