Ionic日本語ドキュメンテーション
Ionic v4+の公式ドキュメントを日本語に翻訳するためのレポジトリです。 コンテンツはionicframework.jpで公開しています。
構成
開発には、npm5.8 +とNode8 +をインストールした環境が必要です。
ローカルプレビュー
$ npm run dev立ち上げが完了すると、localhost:3333/docs/ が自動的に立ち上がります。
なお、/docs/api/ /docs/cli/ docs/native/ 以下はファイルの自動生成を行わないとアクセスすることができません。
ローカルでのアクセスが必要な場合は、先に以下のコマンドを実行してください。
$ npm run predocgen && npm run docgenなお、これによって生成したファイルは翻訳してはいけません。 以下のフォルダ以下のファイルは、ソースファイルのコメントアウトから自動生成するため編集しないようにしてください。
src/content/api/src/content/cli/commands/src/content/native
翻訳ファイル
翻訳を行うファイルは src/content 以下に格納されています。表示されるURLと、「フォルダ/ファイル名」は致するようになっておりますので、ご参考ください。
src/content/intro.md -> /docs/intro
翻訳作業について
コントリビューションのお願い
翻訳プロジェクトは規模が大きく、多くの方々の協力なくては成立しません。ぜひ皆さんのコントリビューションをお待ちしております。また、翻訳作業についての議論はIonic Japan slackの #translation チャンネルで行っておりますのでぜひご参加ください。
Ionicの知見を共有するためのslackのオープンチャンネル
ワークフロー
0. 本レポジトリをForkする
1. 翻訳作業のIssueを作成する
2. 翻訳する
3. プルリクエストを作成する
注意事項
- 本レポジトリは、元レポジトリを引き継ぎ
Apache Licenseを採用しています。皆さんの翻訳も同一ライセンスとなりますのでご了承ください。 - 元レポジトリがライセンスを変更いた場合、本レポジトリはそれに追随する可能性があります。
- 翻訳前と翻訳後で行数が同じになるようにご注意ください。これは、本家のdiffを追跡しやすくするためですのでご協力お願いいたします。