Skip to content

Commit f77b015

Browse files
committed
docs: add README for metadata
1 parent 3106bb6 commit f77b015

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

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-jp/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`ディレクトリが正しく取得されます。

0 commit comments

Comments
 (0)