Skip to content

Commit 3adb593

Browse files
committed
Merge branch 'main' into translate-layout/grid
2 parents 31723b0 + b00a979 commit 3adb593

File tree

133 files changed

+1753
-5179
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

133 files changed

+1753
-5179
lines changed

.github/workflows/website.yml

Lines changed: 9 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ jobs:
1515
runs-on: ubuntu-24.04
1616
steps:
1717
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
18+
with:
19+
submodules: recursive
1820
- uses: jdx/mise-action@13abe502c30c1559a5c37dff303831bab82c9402 # v2.2.3
1921
- uses: Swatinem/rust-cache@9d47c6ad4b02e050fd481d890b2ea34778fd09d6 # v2.7.8
2022
- run: mise run generate-docs
@@ -23,18 +25,20 @@ jobs:
2325
uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
2426
with:
2527
name: build-artifacts
26-
path: website/dist
28+
path: website/typst-docs-web/dist
2729
- name: Deploy
2830
if: github.ref == 'refs/heads/main'
2931
uses: JamesIves/github-pages-deploy-action@6c2d9db40f9296374acc17b90404b6e8864128c8 # v4.7.3
3032
with:
31-
folder: website/dist # The folder the action should deploy.
33+
folder: website/typst-docs-web/dist # The folder the action should deploy.
3234

3335
textlint-md:
3436
runs-on: ubuntu-24.04
3537
steps:
3638
- name: Checkout the repository
3739
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
40+
with:
41+
submodules: recursive
3842
- name: Setup tools
3943
uses: jdx/mise-action@13abe502c30c1559a5c37dff303831bab82c9402 # v2.2.3
4044
- name: Install dependencies
@@ -48,38 +52,15 @@ jobs:
4852
steps:
4953
- name: Checkout the repository
5054
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
55+
with:
56+
submodules: recursive
5157
- name: Download build artifacts
5258
uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4.3.0
5359
with:
5460
name: build-artifacts
55-
path: website/dist
61+
path: website/typst-docs-web/dist
5662
- uses: jdx/mise-action@13abe502c30c1559a5c37dff303831bab82c9402 # v2.2.3
5763
- name: Install dependencies
5864
run: bun install --frozen-lockfile
5965
- name: Lint HTML using textlint
6066
run: bun run --bun textlint-html
61-
62-
website-ci:
63-
runs-on: ubuntu-24.04
64-
defaults:
65-
run:
66-
working-directory: ./website
67-
strategy:
68-
fail-fast: false
69-
matrix:
70-
include:
71-
- task: biome
72-
name: "Run Biome CI"
73-
command: "bun biome ci ."
74-
- task: vitest
75-
name: "Run test runner"
76-
command: "bun run test"
77-
steps:
78-
- name: Checkout the repository
79-
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
80-
- name: Setup tools
81-
uses: jdx/mise-action@13abe502c30c1559a5c37dff303831bab82c9402 # v2.2.3
82-
- name: Install dependencies
83-
run: bun install --frozen-lockfile
84-
- name: ${{ matrix.name }}
85-
run: ${{ matrix.command }}

.gitmodules

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[submodule "website/typst-docs-web"]
2+
path = website/typst-docs-web
3+
url = ../../typst-community/typst-docs-web.git

.mise.toml

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

.textlintignore

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# hayagrivaのsrc/csl/archive.rsで管理されている参考文献フォーマット
2-
website/dist/docs/reference/model/bibliography/index.html
3-
website/dist/docs/reference/model/cite/index.html
2+
website/typst-docs-web/dist/reference/model/bibliography/index.html
3+
website/typst-docs-web/dist/reference/model/cite/index.html

.textlintrc.js

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,29 @@ module.exports = {
55
plugins: ["html"],
66
filters: {
77
comments: true,
8+
allowlist: {
9+
allow: ["/<(code|pre)[^>]*>[\\s\\S]*?</(code|pre)>/"],
10+
},
811
},
912
rules: {
1013
"preset-jtf-style": {
14+
// デフォルトで無効のため
15+
"2.1.5.カタカナ": true,
16+
// デフォルトで無効のため
17+
"2.1.6.カタカナの長音": true,
18+
// デフォルトで無効のため
19+
"2.2.1.ひらがなと漢字の使い分け": true,
1120
// 階層構造を表現する記号としての>の使用例があるため
1221
"4.3.7.山かっこ<>": false,
1322
},
23+
prh: {
24+
rulePaths: ["./prh.yaml"],
25+
checkLink: false,
26+
checkBlockQuote: false,
27+
checkEmphasis: true,
28+
checkHeader: true,
29+
checkParagraph: true,
30+
checkCodeComment: [],
31+
},
1432
},
1533
};

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Typst日本語ドキュメント翻訳プロジェクトにご興味をお持ち
1616
> [!WARNING]
1717
> ここに記載されている内容は改訂中です。現在の手順は最新の[Pull Request](https://github.com/typst-jp/docs/pulls?q=sort%3Aupdated-desc+is%3Apr+is%3Aopen)を参照してください。
1818
19-
1. このGitHubリポジトリをフォークします。
19+
1. このGitHubリポジトリをフォークします。Git submoduleを含むため、リポジトリを`git clone`する際に`--recursive`オプションを付けてください。
2020
2. ドキュメントの実体は、主にMarkdownファイルおよびコンパイラのソースコード内のコメントの2種類から構成されています。それぞれ、下記の注意書きに従って翻訳作業をお願いします。
2121
- `./crates/typst-library/src/`内の`.rs`ファイル群は、Typstのコンパイラのソースコードです。ソースコード内に含まれている、**既存のコメントを直接書き換えて翻訳してください**
2222
- 例1:[Reference > Foundations](https://typst.app/docs/reference/foundations/)を翻訳する際は、`./crates/typst-library/src/foundations/mod.rs`のコメントを編集してください。
@@ -86,7 +86,7 @@ mise run textlint-md # Markdownファイルを翻訳した場合
8686
miseが導入されている環境で初めて当プロジェクトのルートディレクトリに移動すると、以下のように構成ファイルを信頼することを求められます。
8787

8888
```plaintext
89-
mise ERROR Config file /path/to/typst-jp.github.io/.mise.toml is not trusted.
89+
mise ERROR Config file /path/to/typst-jp.github.io/mise.toml is not trusted.
9090
Trust it with `mise trust`.
9191
mise ERROR Run with --verbose or MISE_VERBOSE=1 for more information
9292
```

0 commit comments

Comments
 (0)