Skip to content

Commit 082b31f

Browse files
committed
docs: rewrite README in English
1 parent bd05fb2 commit 082b31f

File tree

2 files changed

+17
-6
lines changed

2 files changed

+17
-6
lines changed

website/README.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
1-
# website
1+
# typst-docs-web
22

3-
> [!NOTE]
4-
> このドキュメントは執筆中です。
3+
<div align="center">
4+
<img src="./images/preview.png" alt="">
5+
</div>
6+
7+
A generator that builds a website from a documentation JSON file generated by typst-docs.
58

69
## Commands
710

811
### Develop
912

1013
> [!NOTE]
11-
> 全文検索のインデックスは[pagefind](https://pagefind.app/)で生成していますが、インデックスの出力先が`dist/`になっているため、現在は開発サーバーで全文検索が機能しません。検索機能関連の開発をする場合は、`bun run build`を実行してから、`bun run preview`でビルド後の状態を確認してください。
14+
> The full-text search index is generated by [pagefind](https://pagefind.app/), but since the output directory is set to `dist/`, full-text search functionality is currently unavailable in the development server. For developing search-related features, please execute `bun run build` first, then use `bun run preview` to inspect the built output.
1215
1316
```sh
1417
bun run dev
@@ -29,10 +32,10 @@ bun run preview
2932
### Check
3033

3134
```sh
32-
# コードスタイルをチェックする
35+
# Check code style
3336
bun run check
3437

35-
# 自動修正を行う
38+
# Apply automatic code fixes
3639
bun run check:write
3740
```
3841

@@ -41,3 +44,11 @@ bun run check:write
4144
```sh
4245
bun run test
4346
```
47+
48+
## Maintainers
49+
50+
- [@3w36zj6](https://github.com/3w36zj6)
51+
52+
## License
53+
54+
This project is derived from [typst/typst](https://github.com/typst/typst) and is licensed under the Apache-2.0 license.

website/images/preview.png

141 KB
Loading

0 commit comments

Comments
 (0)