⚙️
Zenn で書く環境を整える
Zenn の執筆体験を自分でも高めるためにいろいろ設定している。運用していたものがあるていど安定してきたのでまとめる。
tl;dr
GitHub 連携してテンプレを適宜使用してください。実際の運用例も参考に。
GitHub 連携して書く
GitHub 連携のいいところはたくさんある。
- 記事を書く際に Git が使える
- 自分の好きなツールを使える
- CI が使える
- 後述の文章チェック用ツール textlint を自動でかけられる
- PR という形で改善提案を受け取ることができる
- github.dev を使ってどこでも同様の環境で記事が書ける
すでに Zenn エディターで書いている方も、途中から GitHub 連携できるので問題ない。
textlint
文章チェック用ツールの定番。
本体は指定されたルールをチェックする機能のみで、使いたいルールは自分で追加してやる必要がある。とはいえ、日本語で有用なルールはあらかた提供されているのでインストールして設定するのみ。
個人的にいつもお世話になっているルールプリセットは次。
- 日本語のルール集 preset-japanese
- 日本語の技術用語関連のルール集 preset-ja-technical-writing
- 日本語のスペース関連のルール集 preset-ja-spacing
- 辞書管理 Proofdict
たいていのエディターと連携できるので、書くそばからおかしな表現を教えてくれる。
実際に使っている設定を参考にどうぞ。
GitHub Actions
記事を書くときは PR ベースで作業するのだが、そのときに勝手に textlint を実行しておかしなところを教えてくれる。手元でのチェックはたまに抜けることがあるので、 PR マージ前にわかると安心感が上がる。
GitHub で完結するので楽。
どういったことをしているのかは実際の設定を見てもらったほうが早い。
こちらにテンプレがあります
ここまで書いた要素をまとめた repo テンプレートを作っている。
いちいち設定するのめんどくさいなー、という方はこれではじめてみると良いだろう。
注意点はふたつ。
- ルールは細かく設定していないので、こうるさく感じる場合は自分好みに設定が必要
- Proofdict は仕込んでいないので辞書チェックかけたい場合は別途インストールが必要
Discussion