🐡

技術ブログを Zenn で始めるために

2023/11/13に公開

Motivation

技術ブログとして Hugo[1] を GitHub Pages 上で運用していた(といってもあまり記事は書いていなかったが)が、流行りに乗り Zenn に移行したい。

Why Zenn?

まず、一番重視するのが可搬性の良さ。こういったプラットフォームには流行り廃りがあるため、別のプラットフォームに移行する際の難易度が低いほどよい。具体的にはブログ記事が静的な markdown として管理されることが必須条件。

次に SEO の観点も重要だ。コミュニティへの還元の意図も含め、検索エンジンから見えやすいほど良い。

上記 2 点を満たすプラットフォームとして Zenn が最適だと判断した。

Requirements

Zenn を始めるにあたり以下の手順が必要となる。ただし、1 や 2 については特に言及しない。

  1. Zenn のアカウント
  2. ドキュメントを管理する GitHub リポジトリ
  3. zenn-cli のインストール

zenn-cli は npm 経由でインストールする必要がある。自分の環境では node.js や npm は volta[2] でバージョン管理をしているので、以下ではその手順を記載する。

Install volta

% brew install volta
% volta install node
% volta install npm
%
% echo "export PATH=$HOME/.volta/bin:$PATH" >> "~/.zshrc"

Install zenn-cli

% cd your_repo_root
% npm init --yes
% npm install zenn-cli

How to write an article?

記事を書く前に、一度だけリポジトリの初期化を行なう必要がある。

% cd your_repo_root
% npx zenn init

この状態で npx zenn new:article をたたくと ./articles 以下に新規ファイルができるので、それを適宜編集し、GitHub 上に push すると自動でデプロイされる。詳しくは公式ドキュメントを参照。

脚注
  1. https://github.com/gohugoio/hugo ↩︎

  2. https://github.com/volta-cli/volta ↩︎

GitHubで編集を提案

Discussion