UN Smart Maps Documentation

This is the documentation for the UN Smart Maps project for interested and existing volunteers. This website is built using Docusaurus 2.

このドキュメントは、UN Smart Mapsプロジェクトに興味を持っている方や、既存のボランティアの方向けのドキュメントです。このウェブサイトはDocusaurus 2を使用して構築されています。

Requirements / 必要条件

• Node.js version >= 12.13.0.
• Yarn version >= 1.5 (or npm version >= 5.0).

Installation　/ インストール

$ yarn install

Local Development　/ ローカル開発

$ yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

このコマンドはローカル開発サーバーを起動し、ブラウザウィンドウを開きます。ほとんどの変更はサーバーを再起動することなくライブで反映されます。

Japanese Testing　/ 日本語でテスト

$ yarn start --locale ja

This command starts up a Japanese version of the local development server and opens up a browser window.

このコマンドはローカル開発サーバーの日本語バージョンを起動し、ブラウザウィンドウを開きます。

Japanese Translation / 日本語翻訳

$ yarn write-translations --locale ja

This creates a new folder in the i18n directory called ja which contains all the translated files. You can then edit the files in the ja directory to translate the website.

If you want to change or add Japanese only markdown files, then please edit the files in this directory:

i18n\ja\docusaurus-plugin-content-docs\current

The structure is the same as the docs directory, but you can modify it to make it unique to the Japanese site.

これにより、すべての翻訳されたファイルが含まれるi18nディレクトリにjaという名前の新しいフォルダーが作成されます。次に、jaディレクトリ内のファイルを編集して、ウェブサイトを翻訳できます。

もし、日本語のみのマークダウンファイルを変更または追加したい場合は、このディレクトリのファイルを編集してください。

i18n\ja\docusaurus-plugin-content-docs\current

構造はdocsディレクトリと同じですが、日本語サイトに固有のものに変更できます。

Build　/ ビルド

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

このコマンドはbuildディレクトリに静的コンテンツを生成し、任意の静的コンテンツホスティングサービスで提供できます。

Deployment / デプロイ

Pushing to the main branch will trigger a deployment to GitHub pages through GitHub actions.

メインブランチにプッシュすると、GitHubアクションを介してGitHubページにデプロイされます。