Maximum Blog

技術スタック

• Next.js (SSG)
• Github Pages

開発方法

共通の準備

git clone https://github.com/saitamau-maximum/blog.git
cd blog
pnpm install
# もしpnpmがない場合は`npm install -g pnpm`でインストールしてから`pnpm install`を実行してください。

ローカルでの開発

pnpm dev
# `http://localhost:3000`にアクセスしてください。

開発するときはmainブランチからブランチを切ってください。

git checkout -b feat/your-feature-name

ブランチはfeat/から始めてください。 例えばメンバー一覧ページを作る場合はfeat/membersというブランチ名になります。

作業が終わったらmainに向けてプルリクエストを作成してください。

ブログ執筆

ブログ執筆にはブランチを切ってください。

git checkout -b feat/your-blog-name

例えば入門講習会の第4回のブログを書く場合はfeat/intro-course-4というブランチ名になります。

ブログを書き終わったらmainに向けてプルリクエストを作成してください。

blog/以下に{slug}.mdというファイルを作成してください。slugはURLの一部になります。

たとえばblog/intro-course-4.mdというファイルを作成した場合、http://localhost:3000/blog/intro-course-4でアクセスできます。

ファイルの中身は以下のようになっています。

---
title: "Maximumとは"
description: "埼玉大学のプログラミングサークル「Maximum」を紹介します。"
date: "2021-07-10"
authors: ["taro", "jiro", "saburo"]
tags: ["maximum", "埼玉大学", "プログラミングサークル"]
prev: "previous-blog"
next: "next-blog"
---

フィールド名	説明	必須か	備考
title	ブログのタイトル	⭕️
description	ブログの説明	⭕️
date	ブログの投稿日	⭕️	YYYY-MM-DDの形式で入力してください。例えば2021年7月10日に投稿した場合は2021-07-10となります。
authors	ブログの執筆者	⭕️	複数人設定できるので、共同執筆も可能です。githubのユーザー名で設定してください。
tags	ブログのタグ	⭕️	複数設定できます。もしタグがない場合は[]としてください。
prev	前のブログ(前章)	❌	前のブログがない場合はそもそもこのフィールドを設定しないでください。
next	次のブログ(次章)	❌	次のブログがない場合はそもそもこのフィールドを設定しないでください。

バグや新規機能の提案

バグの報告や新規機能の提案があれば気軽にIssuesに投稿してください。

開発への参加方法

開発へ参加したい方はIssuesから自分のやりたいことを探して、Assigneesに自分を追加してください。 すると「自分がこのIssueを担当している」ということになります。 あとはいつものようにブランチを切って開発してください。

Support

Mac環境でpnpm iしたときにnode-pre-gypのエラーが出る場合

brew install pkg-config cairo pango libpng jpeg giflib librsvg pixman

を打ってからpnpm iを実行してください。 Automattic/node-canvas#913