|
| 1 | +<div align="right"> |
| 2 | + <a href="./README.ja.md">[日本語]</a> |
| 3 | + <a href="./README.md">[English]</a> |
| 4 | +</div> |
| 5 | + |
| 6 | +# zenn-qiita-sync |
| 7 | +zenn 用の記事を GitHub にプッシュすると、自動的に qiita に記事を公開するためのツールです。記事を複数のプラットフォームに公開することで、より多くの人と知識を共有できます。 |
| 8 | + |
| 9 | +<details> |
| 10 | + <summary>  <b>目次</b> (クリックすると開きます)</summary> |
| 11 | + |
| 12 | +- [🚀 使い方](#-使い方) |
| 13 | +- [🙋♂️ お願い](#️-お願い) |
| 14 | +- [✉️ お問い合わせ](#️-お問い合わせ) |
| 15 | +- [🙏 謝辞](#-謝辞) |
| 16 | +</details> |
| 17 | + |
| 18 | +## 🚀 使い方 |
| 19 | +このツールを使用するには、以下の手順に従ってください。 |
| 20 | +1. 以下のようなディレクトリ構造を準備します。 |
| 21 | + ``` |
| 22 | + . |
| 23 | + ├── articles ... Zenn形式の記事 |
| 24 | + ├── books ... Zenn形式の本 (任意) |
| 25 | + ├── images ... 記事で使用する画像ファイル |
| 26 | + └── qiita |
| 27 | + └── public ... Qiita形式の記事 |
| 28 | + ``` |
| 29 | +2. `qiita-cli` を使用して Qiita アクセストークンを発行します。 |
| 30 | + - 詳しくは[公式リポジトリ](https://github.com/increments/qiita-cli/tree/v1)をご覧ください |
| 31 | +3. 発行したトークンをシークレット変数として設定します。 |
| 32 | + - `https://github.com/<USERNAME>/<REPO>/settings/secrets/actions/new` に移動すれば設定できます（`<USERNAME>` と `<REPO>` はそれぞれ自分の情報に置き換えてください）。 |
| 33 | + - `QIITA_TOKEN = <Your Qiita Access Token>` の形式で設定してください。 |
| 34 | +
|
| 35 | + <p align="center"> |
| 36 | + <img src="./assets/secrets.png" align=center /> |
| 37 | + </p> |
| 38 | +
|
| 39 | +4. 自分のリポジトリ内の `.github/workflows` に新しいワークフロー（例: `publish.yml`）を作成します。 |
| 40 | +
|
| 41 | + <b>実装例</b>（以下をコピーして貼り付けてください） |
| 42 | +
|
| 43 | + ```yml |
| 44 | + name: Publish articles |
| 45 | +
|
| 46 | + on: |
| 47 | + push: |
| 48 | + branches: |
| 49 | + - main |
| 50 | + - master |
| 51 | + workflow_dispatch: |
| 52 | +
|
| 53 | + permissions: |
| 54 | + contents: write |
| 55 | +
|
| 56 | + concurrency: |
| 57 | + group: ${{ github.workflow }}-${{ github.ref }} |
| 58 | + cancel-in-progress: false |
| 59 | +
|
| 60 | + jobs: |
| 61 | + publish_articles: |
| 62 | + runs-on: ubuntu-latest |
| 63 | + timeout-minutes: 5 |
| 64 | + steps: |
| 65 | + - name: Checkout |
| 66 | + uses: actions/checkout@v4 |
| 67 | + with: |
| 68 | + fetch-depth: 0 |
| 69 | +
|
| 70 | + - name: Run |
| 71 | + uses: C-Naoki/zenn-qiita-sync@main |
| 72 | + with: |
| 73 | + qiita-token: ${{ secrets.QIITA_TOKEN }} |
| 74 | + ``` |
| 75 | + 実際にこのツールを使用している例は[こちら](https://github.com/C-Naoki/zenn-archive/tree/main)を参照してください。 |
| 76 | +
|
| 77 | +## 🙋♂️ お願い |
| 78 | +💙 このツールを気に入っていただけたら、⭐ をつけて、友達にもシェアしてください！ |
| 79 | +
|
| 80 | +## ✉️ お問い合わせ |
| 81 | +質問や提案がある場合は、お気軽に [issue](https://github.com/C-Naoki/zenn-qiita-sync/issues) を投稿してください。フィードバックをいただけると嬉しいです！ご連絡をお待ちしております！ |
| 82 | +
|
| 83 | +## 🙏 謝辞 |
| 84 | +有益な情報や価値あるコードを提供してくださった以下の記事やオープンソースに感謝申し上げます。 |
| 85 | +
|
| 86 | +- [zennに記事を投稿したらqiitaにも同時に投稿されるツールを作った話](https://qiita.com/shunk_jr/items/7d1029cae8f83ee8fd84) |
| 87 | +- [Zenn / Qiitaに投稿する同じ記事を一元管理するGitHubリポジトリを作りました](https://zenn.dev/ot07/articles/zenn-qiita-article-centralized) |
| 88 | +- https://github.com/increments/qiita-cli |
0 commit comments