https://github.com/karamem0/zenn-plugin-emoji

Zenn の記事のアイキャッチ絵文字を内容から生成するためのプラグインです。
https://github.com/karamem0/zenn-plugin-emoji

emoji npm npm-package openai zenn

Last synced: about 1 month ago
JSON representation

Zenn の記事のアイキャッチ絵文字を内容から生成するためのプラグインです。

• Host: GitHub
• URL: https://github.com/karamem0/zenn-plugin-emoji
• Owner: karamem0
• License: mit
• Created: 2024-08-26T11:43:14.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-10-03T08:52:32.000Z (about 1 month ago)
• Last Synced: 2024-10-03T08:55:11.068Z (about 1 month ago)
• Topics: emoji, npm, npm-package, openai, zenn
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/@karamem0/zenn-plugin-emoji
• Size: 58.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# zenn-plugin-emoji

[![.github/workflows/workflow.yml](https://github.com/karamem0/zenn-plugin-emoji/actions/workflows/workflow.yml/badge.svg)](https://github.com/karamem0/zenn-plugin-emoji/actions/workflows/workflow.yml)

[![License](https://img.shields.io/github/license/karamem0/zenn-plugin-emoji.svg)](https://github.com/karamem0/zenn-plugin-emoji/blob/main/LICENSE)

[Zenn](https://zenn.dev/) のアイキャッチ絵文字を記事の内容から生成するためのプラグインです。

## 使用方法

*このプラグインでは OpenAI の GPT を使用しますが環境は提供していません。OpenAI または Azure OpenAI Service の環境をあらかじめご用意ください。*

1. パッケージをインストールします。

    ```

    npm install @karamem0/zenn-plugin-emoji

    ```

1. `.env` または `.env.local` ファイルを作成し以下の環境変数を設定します。

    |キー名|説明|OpenAI|Azure OpenAI Service (API キー)|Azure OpenAI Service (Entra ID アプリケーション)|

    |-|-|-|-|-|

    |OPENAI_API_KEY|OpenAI の API キー|X|||

    |OPENAI_API_VERSION|OpenAI の API バージョン (`2024-05-01` など)||X|X|

    |OPENAI_MODEL_NAME|OpenAI の場合はモデル名、Azure OpenAI Serviceの場合はデプロイ名|X|X|X|

    |AZURE_OPENAI_API_KEY|Azure OpenAI Service の API キー||X||

    |AZURE_OPENAI_ENDPOINT|Azure OpenAI Service のエンドポイント||X|X|

    |AZURE_CLIENT_ID|Entra ID アプリケーションのクライアント ID|||X|

    |AZURE_CLIENT_SECRET|Entra ID アプリケーションのクライアント シークレット|||X|

    |AZURE_TENANT_ID|Entra ID アプリケーションのテナント ID|||X|

    - **OpenAI の例**

        ```

        OPENAI_API_KEY=

        OPENAI_MODEL_NAME=

        ```

    - **Azure OpenAI Service (API キー) の例**

        ```

        AZURE_OPENAI_API_KEY=

        AZURE_OPENAI_ENDPOINT=https://.openai.azure.com

        OPENAI_API_VERSION=

        OPENAI_MODEL_NAME=

        ```

    - **Azure OpenAI Service (Entra ID アプリケーション) の例**

        ```

        AZURE_CLIENT_ID=

        AZURE_CLIENT_SECRET=

        AZURE_TENANT_ID=

        AZURE_OPENAI_ENDPOINT=https://.openai.azure.com

        OPENAI_API_VERSION=

        OPENAI_MODEL_NAME=

        ```

        Entra ID アプリケーションに対して **Cognitive Services OpenAI User** のロールの割り当てが必要です。

1. コマンドを実行します。

    ```

    npx zenn-emoji articles/* -u

    ```

## オプション

|短い名前|長い名前|説明|

|-|-|-|

|`-u`|`--update`|対象のファイルを更新します。|