From dc684be6446df3164c3218fd19682747f1744ce0 Mon Sep 17 00:00:00 2001 From: Shunsuke Kimura Date: Sat, 31 Aug 2024 21:30:48 +0900 Subject: [PATCH 01/13] ADD devcontainer --- .devcontainer/Dockerfile | 19 +++++++++++++++++++ .devcontainer/devcontainer.json | 11 +++++++++++ .gitignore | 3 ++- .vscode/tasks.json | 11 +++++++++++ 4 files changed, 43 insertions(+), 1 deletion(-) create mode 100644 .devcontainer/Dockerfile create mode 100644 .devcontainer/devcontainer.json create mode 100644 .vscode/tasks.json diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile new file mode 100644 index 000000000..6d8e2ee2c --- /dev/null +++ b/.devcontainer/Dockerfile @@ -0,0 +1,19 @@ +# Rust v1.77 as a base image +FROM rust:1.77-slim + +RUN apt-get update && \ + apt-get install -y --no-install-recommends \ + curl \ + # install python3, jinja2 pyyaml + python3 \ + python3-pip \ + && pip3 install --break-system-packages jinja2 pyyaml \ + # install nodejs and serve + && curl -fsSL https://deb.nodesource.com/setup_18.x | bash - \ + && apt-get install -y nodejs \ + && npm install -g serve \ + && apt-get clean \ + && rm -rf /var/lib/apt/lists/* \ + +WORKDIR /workspace +ENV PATH="/root/.cargo/bin:${PATH}" diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json new file mode 100644 index 000000000..ff9cca255 --- /dev/null +++ b/.devcontainer/devcontainer.json @@ -0,0 +1,11 @@ +{ + "name": "typst-jp-domumentation", + "build": { + "dockerfile": "Dockerfile", + "context": ".." + }, + "forwardPorts": [3000], + "workspaceMount": "source=${localWorkspaceFolder},target=/workspace,type=bind,consistency=cached", + "workspaceFolder": "/workspace", + "postStartCommand": "cargo test --package typst-docs --lib -- tests::test_docs --exact --nocapture && python3 ./gen.py && npx serve -n ./dist" +} diff --git a/.gitignore b/.gitignore index f9daa3d7e..e2ebd267d 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,6 @@ # General -.vscode +.vscode/* +!.vscode/tasks.json .idea _things desktop.ini diff --git a/.vscode/tasks.json b/.vscode/tasks.json new file mode 100644 index 000000000..08d8dcb19 --- /dev/null +++ b/.vscode/tasks.json @@ -0,0 +1,11 @@ +{ + "version": "2.0.0", + "tasks": [ + { + "label": "preview: typst-jp documentation", + "type": "shell", + "command": "cargo test --package typst-docs --lib -- tests::test_docs --exact --nocapture && python3 ./gen.py && echo reload or open http://localhost:3000", + "problemMatcher": [] + } + ] +} \ No newline at end of file From 4f646c165d70408b3441088740c3ce966ebf5da5 Mon Sep 17 00:00:00 2001 From: Shunsuke Kimura Date: Sat, 31 Aug 2024 22:28:39 +0900 Subject: [PATCH 02/13] ADD description for Dev Container --- .devcontainer/README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 .devcontainer/README.md diff --git a/.devcontainer/README.md b/.devcontainer/README.md new file mode 100644 index 000000000..373e3ba91 --- /dev/null +++ b/.devcontainer/README.md @@ -0,0 +1,24 @@ +# Dev Containerについて + +Visual Studio Codeで編集する場合には、[Dev Container](https://code.visualstudio.com/docs/devcontainers/containers)を使用してローカル環境でWebページの仕上がりを確認することができます。 +Visual Studio Codeでtypst-jp.github.ioディレクトリを開き以下の操作を実施してください。 +1. Ctrl+Shift+Pから`>Dev Containers: Reopen in Container`を実行 +2. ビルドが完了したらブラウザで http://localhost:3000 に接続 +3. ページを更新した際には、Ctrl+shift+Pから`Tasks: Run task`を実行し`preview: typst-jp documentation`を選択。ビルドが完了したらブラウザを更新。 + + +## 別のエディターを使用している場合 + +別のエディターで編集している場合にもDockerfileの使用のみであれば可能です。 +ターミナルから typst-jp.github.io ディレクトリ上で以下のコマンドを実行してください。 +1. Docker imageをビルドして実行 + ``` + docker build . -f .devcontainer/Dockerfile -t typst-jp-doc + docker run --name typst-jp-doc -p 3000:3000 -it -v "$(pwd):/workspace" -w /workspace --rm typst-jp-doc /bin/bash + ``` +2. Dockerコンテナ内でビルド + ``` + cargo test --package typst-docs --lib -- tests::test_docs --exact --nocapture && python3 ./gen.py && npx serve -n ./dist + ``` +3. ビルドが完了したらブラウザで http://localhost:3000 に接続 +4. ファイルを更新した際には、2 のコマンドを再度実行して、ブラウザを更新。 From e25897ba5754af0849b2cce67e58403f0c7359f1 Mon Sep 17 00:00:00 2001 From: Shunsuke Kimura Date: Sun, 1 Sep 2024 14:08:48 +0900 Subject: [PATCH 03/13] FIX versions --- .devcontainer/Dockerfile | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index 6d8e2ee2c..38374b492 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -7,11 +7,11 @@ RUN apt-get update && \ # install python3, jinja2 pyyaml python3 \ python3-pip \ - && pip3 install --break-system-packages jinja2 pyyaml \ + && python3 -m pip install --break-system-packages jinja2 PyYAML \ # install nodejs and serve && curl -fsSL https://deb.nodesource.com/setup_18.x | bash - \ && apt-get install -y nodejs \ - && npm install -g serve \ + && npm install -g serve@14.2.3 \ && apt-get clean \ && rm -rf /var/lib/apt/lists/* \ From 3805444542ae077ed849bb47bcccfda39b5bb1a2 Mon Sep 17 00:00:00 2001 From: Shunsuke Kimura Date: Sun, 1 Sep 2024 14:11:41 +0900 Subject: [PATCH 04/13] MOD .gitignore for .vscode dir --- .gitignore | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.gitignore b/.gitignore index e2ebd267d..ab2342426 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,5 @@ # General -.vscode/* -!.vscode/tasks.json +# .vscode .idea _things desktop.ini From 837c841b0b49b80489b6c2daace3745741f7017b Mon Sep 17 00:00:00 2001 From: Shunsuke Kimura Date: Sun, 1 Sep 2024 14:34:10 +0900 Subject: [PATCH 05/13] FIX devcontainer README.md --- .devcontainer/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.devcontainer/README.md b/.devcontainer/README.md index 373e3ba91..e91b2dad8 100644 --- a/.devcontainer/README.md +++ b/.devcontainer/README.md @@ -2,9 +2,9 @@ Visual Studio Codeで編集する場合には、[Dev Container](https://code.visualstudio.com/docs/devcontainers/containers)を使用してローカル環境でWebページの仕上がりを確認することができます。 Visual Studio Codeでtypst-jp.github.ioディレクトリを開き以下の操作を実施してください。 -1. Ctrl+Shift+Pから`>Dev Containers: Reopen in Container`を実行 +1. Ctrl+Shift+Pから`> Dev Containers: Reopen in Container`を実行 2. ビルドが完了したらブラウザで http://localhost:3000 に接続 -3. ページを更新した際には、Ctrl+shift+Pから`Tasks: Run task`を実行し`preview: typst-jp documentation`を選択。ビルドが完了したらブラウザを更新。 +3. ページを更新した際には、Ctrl+shift+Pから`> Tasks: Run task`を実行し`preview: typst-jp documentation`を選択。ビルドが完了したらブラウザを更新。 ## 別のエディターを使用している場合 From 3aabf44f167630828f3ce7224be4b520c92435dc Mon Sep 17 00:00:00 2001 From: Shunsuke Kimura Date: Tue, 3 Sep 2024 03:11:54 +0900 Subject: [PATCH 06/13] ADD hyper link --- CONTRIBUTING.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 006daff27..b82048804 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -50,6 +50,8 @@ python ./gen.py Node.jsがインストールされている場合は、`npx serve ./dist`でプレビューできます。 +上記のローカル環境を構築するDokcerfileも整備しております。詳細は[.devcontainer/README.md](.devcontainer/README.md)をご参照ください。 + ## スタイルマニュアル スタイルマニュアルでは、当プロジェクトにおける翻訳の品質確保のための、統一したスタイルの参照基準を提供します。具体的には、基本、文体、表記、用語の4つの観点から、翻訳の際に留意すべき事項を示します。 From 457ae17eab5c5c267f67bc04a3d790f46fac3d1a Mon Sep 17 00:00:00 2001 From: Shunsuke Kimura Date: Tue, 3 Sep 2024 03:12:16 +0900 Subject: [PATCH 07/13] Update README for devcontainer --- .devcontainer/README.md | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/.devcontainer/README.md b/.devcontainer/README.md index e91b2dad8..a2381b00c 100644 --- a/.devcontainer/README.md +++ b/.devcontainer/README.md @@ -1,7 +1,13 @@ -# Dev Containerについて +# ローカル環境を構築するDockerfile -Visual Studio Codeで編集する場合には、[Dev Container](https://code.visualstudio.com/docs/devcontainers/containers)を使用してローカル環境でWebページの仕上がりを確認することができます。 -Visual Studio Codeでtypst-jp.github.ioディレクトリを開き以下の操作を実施してください。 +[Docker](https://docs.docker.com/)を用いてWebページの仕上がりを確認できます。 +以下の操作はDockerがインストール済み、かつDockerデーモンを起動していることが前提となります。 + + +## VS Codeを使用している場合 + +[Dev Container](https://code.visualstudio.com/docs/devcontainers/containers)を使用します。 +Visual Studio Codeでtypst-jp.github.ioディレクトリを開き、以下の操作を実施してください。 1. Ctrl+Shift+Pから`> Dev Containers: Reopen in Container`を実行 2. ビルドが完了したらブラウザで http://localhost:3000 に接続 3. ページを更新した際には、Ctrl+shift+Pから`> Tasks: Run task`を実行し`preview: typst-jp documentation`を選択。ビルドが完了したらブラウザを更新。 @@ -9,14 +15,14 @@ Visual Studio Codeでtypst-jp.github.ioディレクトリを開き以下の操 ## 別のエディターを使用している場合 -別のエディターで編集している場合にもDockerfileの使用のみであれば可能です。 -ターミナルから typst-jp.github.io ディレクトリ上で以下のコマンドを実行してください。 -1. Docker imageをビルドして実行 +ターミナルからDockerfileをビルドして、コマンド実行します。 +typst-jp.github.io ディレクトリ上で以下のコマンドを実行してください。 +1. Docker imageをビルドしてコンテナを作成 ``` docker build . -f .devcontainer/Dockerfile -t typst-jp-doc docker run --name typst-jp-doc -p 3000:3000 -it -v "$(pwd):/workspace" -w /workspace --rm typst-jp-doc /bin/bash ``` -2. Dockerコンテナ内でビルド +2. Dockerコンテナ内でページを生成 ``` cargo test --package typst-docs --lib -- tests::test_docs --exact --nocapture && python3 ./gen.py && npx serve -n ./dist ``` From 5666959be23b5e9d19c8e3b3c769cc3cb4c5f426 Mon Sep 17 00:00:00 2001 From: Shunsuke Kimura Date: Tue, 3 Sep 2024 03:15:19 +0900 Subject: [PATCH 08/13] MOD vscode task label --- .devcontainer/README.md | 2 +- .vscode/tasks.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.devcontainer/README.md b/.devcontainer/README.md index a2381b00c..bb401a857 100644 --- a/.devcontainer/README.md +++ b/.devcontainer/README.md @@ -10,7 +10,7 @@ Visual Studio Codeでtypst-jp.github.ioディレクトリを開き、以下の操作を実施してください。 1. Ctrl+Shift+Pから`> Dev Containers: Reopen in Container`を実行 2. ビルドが完了したらブラウザで http://localhost:3000 に接続 -3. ページを更新した際には、Ctrl+shift+Pから`> Tasks: Run task`を実行し`preview: typst-jp documentation`を選択。ビルドが完了したらブラウザを更新。 +3. ページを更新した際には、Ctrl+shift+Pから`> Tasks: Run task`を実行し`gen: typst-jp documentation`を選択。ビルドが完了したらブラウザを更新。 ## 別のエディターを使用している場合 diff --git a/.vscode/tasks.json b/.vscode/tasks.json index 08d8dcb19..7a5149d1d 100644 --- a/.vscode/tasks.json +++ b/.vscode/tasks.json @@ -2,7 +2,7 @@ "version": "2.0.0", "tasks": [ { - "label": "preview: typst-jp documentation", + "label": "gen: typst-jp documentation", "type": "shell", "command": "cargo test --package typst-docs --lib -- tests::test_docs --exact --nocapture && python3 ./gen.py && echo reload or open http://localhost:3000", "problemMatcher": [] From 47996d330a774a65fb9eb5a5664bd0efbe67ea7e Mon Sep 17 00:00:00 2001 From: Shunsuke Kimura Date: Tue, 3 Sep 2024 03:17:42 +0900 Subject: [PATCH 09/13] Update README for devcontainer --- .devcontainer/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.devcontainer/README.md b/.devcontainer/README.md index bb401a857..9c476fe67 100644 --- a/.devcontainer/README.md +++ b/.devcontainer/README.md @@ -10,7 +10,7 @@ Visual Studio Codeでtypst-jp.github.ioディレクトリを開き、以下の操作を実施してください。 1. Ctrl+Shift+Pから`> Dev Containers: Reopen in Container`を実行 2. ビルドが完了したらブラウザで http://localhost:3000 に接続 -3. ページを更新した際には、Ctrl+shift+Pから`> Tasks: Run task`を実行し`gen: typst-jp documentation`を選択。ビルドが完了したらブラウザを更新。 +3. ページを更新した際には、Ctrl+Shift+Pから`> Tasks: Run task`を実行し`gen: typst-jp documentation`を選択。ビルドが完了したらブラウザを更新。 ## 別のエディターを使用している場合 From 9fde1d99568de8037272a0fc12aca8d6a9fa1a47 Mon Sep 17 00:00:00 2001 From: Shunsuke Kimura Date: Tue, 3 Sep 2024 03:39:26 +0900 Subject: [PATCH 10/13] Upgrade nodejs version --- .devcontainer/Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index 38374b492..5ed9901e3 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -9,7 +9,7 @@ RUN apt-get update && \ python3-pip \ && python3 -m pip install --break-system-packages jinja2 PyYAML \ # install nodejs and serve - && curl -fsSL https://deb.nodesource.com/setup_18.x | bash - \ + && curl -fsSL https://deb.nodesource.com/setup_20.x | bash - \ && apt-get install -y nodejs \ && npm install -g serve@14.2.3 \ && apt-get clean \ From c3b62cda73a68e4e6272295e340b700abeda4540 Mon Sep 17 00:00:00 2001 From: Shunsuke Kimura Date: Tue, 3 Sep 2024 03:49:45 +0900 Subject: [PATCH 11/13] Update README for devcontainer --- .devcontainer/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.devcontainer/README.md b/.devcontainer/README.md index 9c476fe67..8a219018a 100644 --- a/.devcontainer/README.md +++ b/.devcontainer/README.md @@ -9,7 +9,7 @@ [Dev Container](https://code.visualstudio.com/docs/devcontainers/containers)を使用します。 Visual Studio Codeでtypst-jp.github.ioディレクトリを開き、以下の操作を実施してください。 1. Ctrl+Shift+Pから`> Dev Containers: Reopen in Container`を実行 -2. ビルドが完了したらブラウザで http://localhost:3000 に接続 +2. Webサーバーが起動したらブラウザで http://localhost:3000 に接続 3. ページを更新した際には、Ctrl+Shift+Pから`> Tasks: Run task`を実行し`gen: typst-jp documentation`を選択。ビルドが完了したらブラウザを更新。 @@ -26,5 +26,5 @@ typst-jp.github.io ディレクトリ上で以下のコマンドを実行して ``` cargo test --package typst-docs --lib -- tests::test_docs --exact --nocapture && python3 ./gen.py && npx serve -n ./dist ``` -3. ビルドが完了したらブラウザで http://localhost:3000 に接続 -4. ファイルを更新した際には、2 のコマンドを再度実行して、ブラウザを更新。 +3. Webサーバーが起動したらブラウザで http://localhost:3000 に接続 +4. ファイルを更新した際には、2 のコマンドを一旦 Ctrl+C で終了して再度実行、その後ブラウザを更新。 From c5810cee4b99ca09edd9e41506aee4d5600ca793 Mon Sep 17 00:00:00 2001 From: 3w36zj6 <52315048+3w36zj6@users.noreply.github.com> Date: Sun, 8 Sep 2024 22:12:31 +0900 Subject: [PATCH 12/13] Insert final newline --- .vscode/tasks.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.vscode/tasks.json b/.vscode/tasks.json index 7a5149d1d..b288b27fe 100644 --- a/.vscode/tasks.json +++ b/.vscode/tasks.json @@ -8,4 +8,4 @@ "problemMatcher": [] } ] -} \ No newline at end of file +} From a4a6f168dda68c7faf0f219b082e0f3057b40b76 Mon Sep 17 00:00:00 2001 From: 3w36zj6 <52315048+3w36zj6@users.noreply.github.com> Date: Sun, 8 Sep 2024 22:28:28 +0900 Subject: [PATCH 13/13] Fix typo --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b82048804..a592f1a09 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -50,7 +50,7 @@ python ./gen.py Node.jsがインストールされている場合は、`npx serve ./dist`でプレビューできます。 -上記のローカル環境を構築するDokcerfileも整備しております。詳細は[.devcontainer/README.md](.devcontainer/README.md)をご参照ください。 +上記のローカル環境を構築するDockerfileも整備しております。詳細は[.devcontainer/README.md](.devcontainer/README.md)をご参照ください。 ## スタイルマニュアル