crowd4u.github.io

執筆者ガイド

おことわり

ここでは正確な説明をするために、mustache 構文を用いて説明する部分があります。

環境構築

1. Hugo の入手

公式サイトを参照してください。

1. リポジトリのクローン

適当なディレクトリに移動し、以下 2 行のいずれかを実行します:

git clone https://github.com/crowd4u/crowd4u.github.io.git
git clone git@github.com:crowd4u/crowd4u.github.io.git

2. submodule の入手

クローンしてきたリポジトリのディレクトリへ移動したら、以下のコマンドを順に実行してください:

git submodule init
git submodule update

記事を執筆する

1. 著者情報ファイルの作成(初回のみ)

初めて記事を書く場合は data/authors/eniehack.toml といったように、{{author_name}}.tomlを作成してください。 内容は以下の通りです:

name = "Nakaya" # 表示される名前
id = "eniehack" # URL に使用される文字列。「この著者が書いた記事一覧」ページの URL に用いられる。
description = "B4 の Nakaya です！crowd4u.github.io の構築運用をしています。" # 著者ページに表示される自己紹介。Markdown が使える。

[[links]] # 著者ページで名前に下に貼られるリンクを links として定義します
name = "Twitter" # アンカーテキストです
link = "https://twitter.com/eniehack" # アンカーテキストをクリックすると飛ぶ url です

[[links]] # links は複数定義することもできます。
name = "Website"
link = "https://eniehack.net/~eniehack"

2. avatar の追加(初回のみ、任意)

初めて記事を書く際、オプションで自分の Avatar を追加することができます。 ファイルはassets/avatars 以下に {{toml で定義した id}}.pngに置きます。 例えば上の著者情報ファイルの場合はassets/avatars/eniehack.png に avatar を置きます。

2. 原稿ファイルの作成

まず、以下のコマンドを実行してください。

hugo new posts/{{ title }}.md

そして、5行目のauthor には、最初作った toml のファイル名（ディレクトリ名などは記載する必要はありません）から拡張子を抜いた文字列を記述します（例: eniehack.toml であれば eniehack）。

3. 原稿のプレビューを確認する

以下コマンドを実行します:

hugo server -D

4. 原稿を提出する

原稿を作成し、プレビューに問題がなければ、branch を切って commit し、pull request を投げてください。

注意すべき点としては、Hugo には draft という状態を各記事が持っていることです。 デフォルトでは draft な状態に置かれているので、公開する直前になったら記事ファイルの 4 行目にあるdraftをfalseにしてください。

タグルールについて

• Notion上のタグで使用するタグは管理する (ここもレビュー対象)
• 「crowd4u」と「C4U」の様に同一の意味のタグは統一する
• タグの付けすぎなどには注意