Open6
Zenn CLIを使って記事をGitHub管理
slug って?
記事の一意な ID
一致していれば、例えば違うリポジトリをGitHub連携してプッシュすると上書きされる
Zenn CLI インストール
Node.js 環境を作っておく
これを読む
CLIをインストールする先はGitHub連携 したレポジトリをクローンしたディレクトリであること
node.js 環境を作っている
npm init --yes
zenn-cli モジュールを入れている
npm install zenn-cli
node_modules ディレクトリは gitignore 対象なので上の2つのコマンドはgitレポジトリをクローンするたびに行う
Zenn CLI の使い方
これを読む
これで記事作成
slug はランダムになるが、これでいいと思う
npx zenn new:article
よくない、記事が増えるとファイル名だけでは編集したい記事がわからなくなる
npx zenn new:article --slug [命名するslug]
命名するslug
は [接頭辞]-[メインのトピックス]-[記事の簡潔なタイトル]
で行こうと思おう
作成されたファイルの中身の上部はこうなっている
hoge.md
---
title: "" # 記事のタイトル
emoji: "😸" # アイキャッチとして使われる絵文字(1文字だけ)
type: "tech" # tech: 技術記事 / idea: アイデア記事
topics: [] # タグ。["markdown", "rust", "aws"]のように指定する
published: true # 公開設定(falseにすると下書き)
---
-
title
: は空のままだと怒られるので必ず入れる -
emoji
: Mac なら control + command + space で入力できる -
topics
: ここを参考にする
記事に画像を入れたい
これを読む
その記事だけで使う画像は slug で階層を掘るといい
images/[slug]/image1.png
- ファイルサイズは 3MB 以内
- 相対パスはダメ
Git LFS は使えない?
LFS にあげた画像は Zenn 側から参照できないみたい?