Ionic Framework 日本語ドキュメンテーション

Ionic v4+ の公式ドキュメントを日本語に翻訳するためのレポジトリです。 コンテンツは ionicframework.jp で公開しています。

構成

開発には、npm5.8 +とNode8 +をインストールした環境が必要です。

ローカルプレビュー

$ npm start

立ち上げが完了すると、localhost:3333/docs/ が自動的に立ち上がります。なお、はじめてのビルド時は以下を実行してください。

$ npm install
$ npm run prebuild

翻訳ファイル

翻訳を行うファイルは 拡張子が md となっております。src/pages/intro.md のコンテンツは、URLは /docs/intro となります。 変更すればGitで追跡できる（ .gitignore に含まれていない）ファイルは通常の手順で翻訳可能です。翻訳前と翻訳後の行数が一致するように気をつけて作業ください。

なお、 Components、API、CLIは特別な処理が入るため、翻訳するファイルは src/transalate/ にそれぞれ格納されています。 ファイル名の末尾が readme.md となっているファイルを翻訳ください。

Components、API、CLI については翻訳をローカルプレビューに適用するには以下コマンドを実行する必要があります。

$ npm run translate

表記揺れ対応

元表記	日本語表記	備考
Components	コンポーネント	一般用語
Function/Functions	機能	一般用語
Test	テスト	一般用語
Page/Pages	Page	Ionic v3の特定機能を指す場合
Component/Components	Component	Angularの特定機能を指す場合。ただし、UIパーツを指す場合は「コンポーネント」と日本語表記。
Service/Services	Service	Angularの特定機能を指す場合
Pipe/Pipes	Pipe	Angularの特定機能を指す場合
Provider/Providers	Provider	Angularの特定機能を指す場合
Module/Modules	Module	Angularの特定機能を指す場合
Lazy Loading	Lazy Loading	一般用語

翻訳作業について

コントリビューションのお願い

翻訳プロジェクトは規模が大きく、多くの方々の協力なくては成立しません。ぜひ皆さんのコントリビューションをお待ちしております。また、翻訳作業についての議論はIonic Japan slackの #translation チャンネルで行っておりますのでぜひご参加ください。

Ionicの知見を共有するためのslackのオープンチャンネル Ionic Japan Users Group

ワークフロー

0. 本レポジトリをForkする

1. 翻訳作業のIssueを作成する

2. 翻訳する

3. プルリクエストを作成する

注意事項

• 本レポジトリは、元レポジトリを引き継ぎ Apache License を採用しています。皆さんの翻訳も同一ライセンスとなりますのでご了承ください。
• 元レポジトリがライセンスを変更した場合、本レポジトリはそれに追随する可能性があります。
• 翻訳前と翻訳後で行数が同じになるようにご注意ください。これは、本家のdiffを追跡しやすくするためですのでご協力お願いいたします。
• Contributing Guide 🔦
• Project Board 📌