Skip to content

Commit a3f0f20

Browse files
committed
Update: description
Signed-off-by: Shunsuke Kimura <[email protected]>
1 parent f90a22f commit a3f0f20

File tree

2 files changed

+18
-19
lines changed

2 files changed

+18
-19
lines changed

.devcontainer/README.md

Lines changed: 0 additions & 15 deletions
This file was deleted.

CONTRIBUTING.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,8 @@ Typst日本語ドキュメント翻訳プロジェクトにご興味をお持ち
4040

4141
また、当プロジェクトが独自に導入しているRustを除く開発ツールおよびコマンドは[mise](https://mise.jdx.dev/)で一元管理しています。導入していない場合は、[Getting Started | mise-en-place](https://mise.jdx.dev/getting-started.html)に従ってインストールしてください。
4242

43+
Dockerで作業したい方へ向けて、[Dev Containerの環境](#dev-containerを用いた方法)もご用意しております。
44+
4345
#### TL;DR
4446

4547
> [!NOTE]
@@ -123,9 +125,21 @@ mise run preview
123125
mise run generate
124126
```
125127

126-
#### Dev Containerについて
128+
#### Dev Containerを用いた方法
127129

128-
> [!WARNING]
129-
> Dev Containerは現在miseに対応していません。そのため、Dev Containerを使用する場合は、`.mise.toml`を参考に手動で上記の手順を実行してください。
130+
[Docker](https://docs.docker.com/)を用いてWebページの仕上がりを確認できます。
131+
以下の操作はDockerがインストール済み、かつDockerデーモンを起動していることが前提となります。
132+
[Dev Container](https://code.visualstudio.com/docs/devcontainers/containers)を使用します。
133+
Visual Studio Codeにおける操作フロー例は以下の通りです。
134+
135+
1. Ctrl+Shift+Pを押してから`> Dev Containers: Reopen in Container`を実行します。
136+
2. Webサーバーが起動したらブラウザで http://localhost:5173 にアクセスします。
137+
3. 翻訳したファイルの変更を反映させるためにはCtrl+Shift+Bでビルドを実行します。
138+
4. 体裁を確認したい場合、Ctrl+Shift+Pを押してから`> Tasks: Run task`を実行し以下のいずれかを選択します。
139+
- `textlint-md` : Markdownファイルを翻訳した場合
140+
- `textlint-html` : Rustソースコードを翻訳した場合
141+
5. 自動修正を実施したい場合も同様に以下から選択します。
142+
- `textlint-md:fix` : Markdownファイルを自動修正します。
143+
- Rustコードの自動修正は対応していなため、該当箇所を手動で修正してください。
130144

131-
上記のローカル環境を構築するDockerfileも整備しております。詳細は[.devcontainer/README.md](.devcontainer/README.md)をご参照ください
145+
`> Tasks: Run task`はDocker環境でなく、miseで環境構築した際にも使用できます

0 commit comments

Comments
 (0)