新しい記事の作成

hugo new --kind has-image post/{sub-category}/{post-name}

hugo new post/{sub-category}/{post-slug}.md

例: hugo new --kind has-image post/bicycle/my-new-bike

画像なしの記事を作成したい場合は下を選ぶ。

デフォルトで{post-name}がslugに設定される。 slugが重複している場合、ビルド時にエラーが出るようになるのでその際はslugをユニークなものに変更すること。 記事内で使う画像リソースは{post-name}のディレクトリ内に配置すればよい。

画像の配置は![alt属性で表示される説明文](画像ファイル名)。

タグについて

frontmatterで設定する。

tags:
    - タグ1
    - タグ2

タグを設定しない場合はtagsはあってもいいが、その配下のリストは削除しておくこと。 -だけあるとpermalinkの重複によってビルドが失敗する。

サマリについて

サマリを登録する方法は2つ

1. <!--more-->までの部分に書いたもの
2. frontmatterのdescriptionに書いたもの

優先度はdescriptionが高く、値が設定されていないdescriptionが存在すると<!--more-->は無視される。

参照の仕方:

1. .Summary
2. .Params.description

ショートコード

Markdown内で使えるショートコード: 公式ドキュメント

{{< ショートコード >}}のような形で使う

• gist {{< gist username gistID >}}
• tweet {{< tweet tweetID >}}
• YouTube: {{< youtube ビデオID >}}
• リンク {{< ref "コンテンツのslug" >}}

リンクに関してはURLに変換されるだけのため、[hoge]({{< ref "hoge" >}})のように使う必要がある。

textlintの一時的な無効化

どうしてもtextlintのルールを無視したい場合はつぎのコメントを挿入することで、部分的にtextlintを無効化できる。

<!-- textlint-disable -->
ここはtextlintのルールを無視してもエラーにならない
<!-- textlint-enable -->
以降はtextlintのルールが有効になってチェックされる。

記事中で話し言葉っぽい書き方をどうしてもしたいときなどに使える。

デプロイ

現状では記事を書いたらプルリクを送り、その後masterにマージしたら公開されるようになっている。

git pushしたあとhub pull-requestでプルリクを送る。マージはGitHub上でやる。

./script/delete-merged-branch.shを実行すれば作成したマージ済みのブランチを消すことができる。

ライセンス

利用しているhugoテーマ: aether

MIT © Joe Hutchinson

改変している部分に関してはMIT © gen0083

記事自体のライセンス Copyright © gen0083

というスタンスですが、細かくはまたあとで整備する