Skip to content

Commit 1abb644

Browse files
committed
Update README
Signed-off-by: Shunsuke Kimura <[email protected]>
1 parent 8a8f948 commit 1abb644

File tree

1 file changed

+3
-23
lines changed

1 file changed

+3
-23
lines changed

.devcontainer/README.md

Lines changed: 3 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -9,27 +9,7 @@
99
Visual Studio Codeでtypst-jp.github.ioディレクトリを開き、以下の操作を実施してください。
1010

1111
1. Ctrl+Shift+Pから`> Dev Containers: Reopen in Container`を実行
12-
2. Webサーバーが起動したらブラウザで http://localhost:8000 に接続
13-
3. ページを更新した際には、Ctrl+Shift+Pから`> Tasks: Run task`を実行し`generate-docs`を選択、ビルドが完了したらブラウザを更新
14-
4. 体裁を確認したい場合、同様に`> Tasks: Run task`を実行し`textlint-md`(markdownファイルを翻訳した場合)または`textlint-html`(Rustソースコードを翻訳した場合)を選択
12+
2. Webサーバーが起動したらブラウザで http://localhost:5173 に接続
13+
3. ページを更新した際には、Ctrl+Shift+Bでビルドを実行
14+
4. 体裁を確認したい場合、Ctrl+Shift+Pから`> Tasks: Run task`を実行し`textlint-md`(markdownファイルを翻訳した場合)または`textlint-html`(Rustソースコードを翻訳した場合)を選択
1515
5. 自動修正を実施したい場合、markdownファイルの添削であれば、同様に`textlint-md:fix`を選択(Rustコードは対応していなため、該当箇所を手動で修正してください。)
16-
17-
18-
## 別のエディターを使用している場合
19-
20-
ターミナルからDockerfileをビルドして、コマンド実行します。
21-
typst-jp.github.io ディレクトリ上で以下のコマンドを実行してください。
22-
23-
1. Docker imageをビルドしてコンテナを作成
24-
```
25-
docker build . -f .devcontainer/Dockerfile -t typst-jp-doc
26-
docker run --name typst-jp-doc -p 8000:8000 -it -v "$(pwd):/workspace" -w /workspace --rm typst-jp-doc /bin/bash
27-
```
28-
2. Dockerコンテナ内でページを生成
29-
```
30-
cargo test --package typst-docs --lib -- tests::test_docs --exact --nocapture && python3 ./gen.py && npx serve -n ./dist
31-
```
32-
3. Webサーバーが起動したらブラウザで http://localhost:8000 に接続
33-
4. ファイルを更新した際には、2 のコマンドを一旦 Ctrl+C で終了して再度実行、その後ブラウザを更新
34-
5. 体裁を確認したい場合には、初めの一回だけ`bun install --frozen-lockfile`を実行した後、`bun run textlint-md`や`bun run textlint-html`を実行
35-
6. markdownファイルの体裁を修正したい場合には`textlint-md:fix`を実行

0 commit comments

Comments
 (0)