English | 简体中文 | Español | Français | Deutsch | 한국어
S.S. Markdownは、Markdownファイルを多言語展開するためのGitHub Actionsです。
下記のAPIが使用できます。
- OpenAI
- DeepSeek(動作未確認)
- Google(Gemini)(動作未確認)
Input | Description | Required | Default |
---|---|---|---|
file |
翻訳するMarkdownファイルのパス | No | README.md |
openai-api-key |
OpenAI APIキー | No | - |
deepseek-api-key |
DeepSeek APIキー | No | - |
google-api-key |
Google APIキー | No | - |
google-model |
Google Generative AIモデル名 | No | - |
openai-model |
OpenAIモデル名 | No | - |
ss-model |
使用するモデルプロバイダーの設定('openai' or 'deepseek' or 'google') | Yes | - |
languages |
翻訳する言語コード(カンマ区切り) | No | en,zh,fr,es,de,ko |
name: Translate Docs
on:
workflow_dispatch:
jobs:
translate:
permissions:
contents: write
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: n3xem/[email protected]
with:
file: "README.md"
openai-api-key: ${{ secrets.SS_MARKDOWN_OPENAI_API_KEY }}
openai-model: "gpt-4o-mini"
ss-model: "openai"
- uses: EndBug/add-and-commit@v9
各言語へのリンクなど、翻訳されたマークダウンに挿入したくない文章がある場合は、ss-markdown-ignore start/end
ディレクティブで囲むことで翻訳されないようにすることができます。
ここの文章は翻訳されます。
下記のディレクティブによって翻訳が無視されます。(翻訳されたマークダウンを読んでいる人は、原文を読んで何が起きているか確認してください)
<!-- ss-markdown-ignore start -->
ここは翻訳されません。
<!-- ss-markdown-ignore end -->
ディレクティブが終了したので、ここの文章は翻訳されます。