Skip to content

Commit fab5c83

Browse files
committed
Merge remote-tracking branch 'origin/main' into feature/add-textlint-rule-prh
2 parents e7ddb47 + 38de3e0 commit fab5c83

File tree

84 files changed

+52
-5685
lines changed

Some content is hidden

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

84 files changed

+52
-5685
lines changed

.github/workflows/website.yml

Lines changed: 6 additions & 25 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
@@ -35,6 +37,8 @@ jobs:
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,6 +52,8 @@ 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:
@@ -58,28 +64,3 @@ jobs:
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/typst-docs-web
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

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
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`のコメントを編集してください。

crates/typst-library/src/html/mod.rs

Lines changed: 24 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -17,21 +17,21 @@ pub fn module() -> Module {
1717
Module::new("html", html)
1818
}
1919

20-
/// An HTML element that can contain Typst content.
20+
/// Typstのコンテンツを含むことができるHTML要素。
2121
///
22-
/// Typst's HTML export automatically generates the appropriate tags for most
23-
/// elements. However, sometimes, it is desirable to retain more control. For
24-
/// example, when using Typst to generate your blog, you could use this function
25-
/// to wrap each article in an `<article>` tag.
22+
/// TypstのHTMLエクスポートは、ほとんどの要素に対して適切なタグを自動的に生成します。
23+
/// ただし、より細かく制御したい場合もあります。
24+
/// 例えば、Typstを使ってブログを生成する場合、
25+
/// この関数を用いると、それぞれの記事を`<article>`タグで囲めます。
2626
///
27-
/// Typst is aware of what is valid HTML. A tag and its attributes must form
28-
/// syntactically valid HTML. Some tags, like `meta` do not accept content.
29-
/// Hence, you must not provide a body for them. We may add more checks in the
30-
/// future, so be sure that you are generating valid HTML when using this
31-
/// function.
27+
/// Typstは有効なHTMLが何であるかを認識しています。
28+
/// タグとその属性は、構文的に有効なHTMLを構成していなければなりません。
29+
/// `meta`のようないくつかのタグはコンテンツを受け付けません。
30+
/// したがって、それらに対して本文を提供してはいけません。
31+
/// 将来的に、この機能に対して更に多くのチェックを追加する可能性があるため、この関数を使用する際は有効なHTMLを生成していることを確認してください。
3232
///
33-
/// Normally, Typst will generate `html`, `head`, and `body` tags for you. If
34-
/// you instead create them with this function, Typst will omit its own tags.
33+
/// 通常、Typstは`html``head`、および`body`タグを生成します。
34+
/// 代わりにこの関数でそれらを作成した場合、Typstは自身の生成するタグを省略します。
3535
///
3636
/// ```typ
3737
/// #html.elem("div", attrs: (style: "background: aqua"))[
@@ -40,17 +40,17 @@ pub fn module() -> Module {
4040
/// ```
4141
#[elem(name = "elem")]
4242
pub struct HtmlElem {
43-
/// The element's tag.
43+
/// 要素のタグ。
4444
#[required]
4545
pub tag: HtmlTag,
4646

47-
/// The element's HTML attributes.
47+
/// 要素のHTML属性。
4848
#[borrowed]
4949
pub attrs: HtmlAttrs,
5050

51-
/// The contents of the HTML element.
51+
/// HTML要素の内容。
5252
///
53-
/// The body can be arbitrary Typst content.
53+
/// 本文には任意のTypstコンテンツを指定できます。
5454
#[positional]
5555
#[borrowed]
5656
pub body: Option<Content>,
@@ -64,19 +64,18 @@ impl HtmlElem {
6464
}
6565
}
6666

67-
/// An element that lays out its content as an inline SVG.
67+
/// コンテンツをインラインSVGとしてレイアウトする要素。
6868
///
69-
/// Sometimes, converting Typst content to HTML is not desirable. This can be
70-
/// the case for plots and other content that relies on positioning and styling
71-
/// to convey its message.
69+
/// TypstのコンテンツにはHTMLへの変換が不適切なものがあります。
70+
/// グラフプロットや、意味を伝えるために位置決めやスタイルに依存するコンテンツが該当します。
7271
///
73-
/// This function allows you to use the Typst layout engine that would also be
74-
/// used for PDF, SVG, and PNG export to render a part of your document exactly
75-
/// how it would appear when exported in one of these formats. It embeds the
76-
/// content as an inline SVG.
72+
/// この関数を使用すると、
73+
/// PDFSVG、およびPNGエクスポートにも使用されるTypstレイアウトエンジンを使用して、
74+
/// 文書の一部を、これらの形式のいずれかでエクスポートした場合に表示されるのとまったく同じようにレンダリングできます。
75+
/// この関数はコンテンツをインラインSVGとして埋め込みます。
7776
#[elem]
7877
pub struct FrameElem {
79-
/// The content that shall be laid out.
78+
///レイアウト対象のコンテンツ。
8079
#[positional]
8180
#[required]
8281
pub body: Content,

website/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# website metadata
2+
3+
このディレクトリでは、ドキュメントのWebサイトの構築に必要なメタデータを管理しています。
4+
5+
また、SSG(静的サイトジェネレーター)の本体は、Git submoduleとして別リポジトリの[typst-docs-web](https://github.com/typst-community/typst-docs-web)で管理されています。
6+
7+
## Git submoduleの初期化について
8+
9+
リポジトリを`git clone`する際に`--recursive`オプションを付けていない場合は、以下のコマンドでsubmoduleを初期化・更新できます。
10+
11+
```sh
12+
git submodule update --init --recursive
13+
```
14+
15+
これにより、`typst-docs-web`ディレクトリが正しく取得されます。

website/translation-status.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -162,8 +162,8 @@
162162
"/docs/reference/pdf/": "translated",
163163
"/docs/reference/pdf/embed/": "translated",
164164
"/docs/reference/html/": "translated",
165-
"/docs/reference/html/elem/": "untranslated",
166-
"/docs/reference/html/frame/": "untranslated",
165+
"/docs/reference/html/elem/": "translated",
166+
"/docs/reference/html/frame/": "translated",
167167
"/docs/reference/png/": "untranslated",
168168
"/docs/reference/svg/": "untranslated",
169169
"/docs/guides/": "translated",

website/typst-docs-web

Submodule typst-docs-web added at ddbabe0

website/typst-docs-web/.editorconfig

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

website/typst-docs-web/.env.example

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

website/typst-docs-web/.gitignore

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

0 commit comments

Comments
 (0)