通常の範囲に加え、マークダウンやその他平文ドキュメントのための国際化(i18n)ユーティリティ
これは npm workspaces によるモノレポです。設計の全体像は docs/DESIGN.md にまとまっています。構造を変更する前に読んでください。
| パッケージ | npm | パス | 内容 |
|---|---|---|---|
kiritan |
npm | packages/kiritan |
CLI とビルドパイプライン(設定・翻訳ストア・レンダラー・翻訳ミドルウェア) |
@kiritan/runtime |
npm | packages/runtime |
ビルド時依存を持たない、最小限の t(key, params) ランタイム |
@kiritan/middleware |
npm | packages/middleware |
任意の翻訳関数をミドルウェアにする層: コード/URL/%{name} の保護、分割、まとめ送信、再試行、キャッシュ |
@kiritan/free-translate |
npm | packages/free-translate |
APIキー不要の翻訳ミドルウェア: MyMemory、Googleのキーレスエンドポイント、自前ホストのLibreTranslateとGoogle Apps Script |
@kiritan/deepl |
npm | packages/deepl |
translate.middlewares 用の DeepL 翻訳ミドルウェア |
@kiritan/google-translate |
npm | packages/google-translate |
translate.middlewares 用の Google Cloud Translation ミドルウェア |
otoneko1102.kiritan— VS Code拡張機能::::kiritan{...}ディレクティブブロックのシンタックスハイライト。npmパッケージではないためpackages/ではなくextensions/配下にあります。extensions/vim— 同じディレクティブハイライトに加え、*.kiritanconfigのfiletype判定をカバーするVim/Neovimプラグイン。skills/kiritan— Kiritanプロジェクト内での作業のしかた(*.base.mdソースの編集、ディレクティブ記法、どのCLIコマンドを使うべきか)をAIコーディングエージェントに教える Agent Skill。npmパッケージではないため、Skills CLI で導入する:npx skills add otnc/kiritan --skill kiritan(-gを付けると現在のリポジトリではなくユーザー全体にインストールできる。npx skills add otnc/kiritan --listでインストールせずにプレビュー、npx skills update kiritan/npx skills remove kiritanで管理)。詳細は skills/README.md を参照。
Warning
Kiritan はまだ開発初期段階です(pre-1.0)。設定の形や API は今後も変わる可能性があります。build / check / translate / extract / typegen はすべて実装済みです。使い方は各パッケージの README を、今後の展望は docs/DESIGN.md 13章を参照してください。
- Node.js >= 22
コントリビューションを歓迎します。詳細は CONTRIBUTING.md を参照してください。
WTFPL License の下で配布されています。
Note
assets/ 配下の画像ファイル(.png / .gal)は WTFPL の対象外です。本ライブラリの紹介(ブログ記事など)といった用途には使用できますが、アプリケーションのロゴ/アイコンとして使ったり、他の製品に組み込んだりすることはできません。詳細は ASSETS_LICENSE.md を参照してください。