Contribution Guide

Issues

zenn.dev に関する問題や改善提案はzenn-communityの Issues をご利用ください。
zenn-cli に関する問題や改善の提案についてはzenn-community もしくは本リポジトリの Issues をご利用ください。

Pull Requests

レビューに時間がかかる場合やマージを行わずにクローズする場合があります。特に機能追加に関してはあらかじめ Issues で議論させていただければと思います。

PR 作成時の注意点

canaryブランチに対して作成してください。

リリースフロー

canary バージョン（α 版）のリリース

canary ブランチに変更をマージするとcanaryバージョンが自動リリースされます
canary バージョンはnpm install zenn-cli@canaryで試すことができます

latest バージョン（正式版）のリリース

canary ブランチから main ブランチに PR を作成します（release ラベルを付与）
main ブランチにマージされるとlatestバージョンが自動リリースされます
ユーザーは npm install zenn-cli@latest でインストールできます

構成

lerna を使ったモノレポ管理をしています

zenn-cli: ローカルの markdown ファイルを管理/プレビュー
zenn-content-css: コンテンツ本文の CSS（ZennCLI および zenn.dev で使用）
zenn-embed-elements: KaTeX記法を有効化するためのCustom Elements（ZennCLI および zenn.dev で使用）
zenn-markdown-html: マークダウンから HTML への変換を行う（Zenn CLI および zenn.dev で使用）

Develop

zenn-cli

WIP

src/client: zenn preview時のクライアント
- ビルドされたファイルをpublishするため、依存はdevDependenciesに指定する
src/server: zenn preview時のサーバー（クライアントから参照するAPI）