Skip to content

Latest commit

 

History

History
82 lines (51 loc) · 3.3 KB

README.md

File metadata and controls

82 lines (51 loc) · 3.3 KB
Raw

Svelte Site JP

Svelteの公式ページsvelte.devを日本語に翻訳するプロジェクトです。

Svelteは素晴らしいツールで、公式ドキュメント及びチュートリアルも非常に素晴らしいです。公式からは英語版のみ提供されていますが、日本語に翻訳されたドキュメントとチュートリアルがあれば日本語話者にとってはもっと学習しやすくなると考えています。

翻訳はまだまだ進行中ですが、https://svelte-jp.herokuapp.com/で閲覧することができます。

進捗はMilestonesで確認できます。

貢献(Contribution)について

この翻訳プロジェクトではみなさんの貢献を歓迎しています！

興味がある方はCONTRIBUTING.mdをご参照ください。

意見や気が付いたことがあれば、お気軽にIssueを作成ください。もしくはSvelte日本のDiscordの #ドキュメント翻訳チャンネルに投稿頂いても構いません。

Running locally

Set up the site sub-project:

git clone https://github.com/tomoam/svelte-site-jp.git
cd svelte-site-jp
npm ci
npm run update
npm run dev

and navigate to localhost:3000.

REPL GitHub integration

In order for the REPL's GitHub integration to work properly when running locally, you will need to:

  • create a GitHub OAuth app:
    • set Authorization callback URL to http://localhost:3000/auth/callback;
    • set Application name as you like, and Homepage URL as http://localhost:3000/;
    • create the app and take note of Client ID and Client Secret
  • in this repo, create site/.env containing: 
    GITHUB_CLIENT_ID=[your app's Client ID]
GITHUB_CLIENT_SECRET=[your app's Client Secret]
BASEURL=http://localhost:3000

Building the site

To build the website, run npm run build. The output can be found in __sapper__/build.

Testing

Tests can be run using npm run test.

Linking @sveltejs/site-kit and @sveltejs/site-repl

This site depends on @sveltejs/site-kit, a collection of styles, components and icons used in common by *.svelte.dev websites, and @sveltejs/site-repl.

In order to work on features that depend on those packages, you need to link their repositories:

  • cd <somewhere>
  • git clone https://github.com/sveltejs/site-kit
  • git clone https://github.com/sveltejs/svelte-repl
  • cd <somewhere>/site-kit
  • npm link
  • cd <somewhere>/svelte-repl
  • npm link
  • cd <svelte-repo>/site
  • npm link @sveltejs/site-kit
  • npm link @sveltejs/svelte-repl

Translating the API docs

Anchors are automatically generated using headings in the documentation and by default (for the english language) they are latinised to make sure the URL is always conforming to RFC3986.

If we need to translate the API documentation to a language using unicode chars, we can setup this app to export the correct anchors by setting up SLUG_PRESERVE_UNICODE to true in config.js.