Skip to content

Commit 2664d5e

Browse files
committed
update readme
1 parent 7019879 commit 2664d5e

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -84,11 +84,6 @@ Cloudflare Worker のビルドログとステータス表示が見れますが
8484

8585
## ドキュメント
8686

87-
```bash
88-
npm run checkDocs
89-
```
90-
でドキュメントの読み込み時にエラーにならないか確認できます (index.ymlの間違いなど)
91-
9287
* ドキュメントはセクション(見出し)ごとにわけ、 public/docs/言語id/ページid/並び替え用連番-セクション名.md に置く。
9388
* ページはディレクトリの名前によらず 言語id/index.yml に書かれている順で表示される。
9489
* セクションはセクションIDによらずファイル名順で表示される。
@@ -97,6 +92,10 @@ npm run checkDocs
9792
id: 一意なセクションID。ファイル名・ディレクトリ名と一致していなくても良い。バックエンドがこのセクションIDで識別するので、一度コミットしたら変更不可(ファイル名は何度変えても良い)
9893
title: セクションタイトルと同じものをmd記法を使わずに書いた文字列
9994
level: セクションの見出しレベル(2〜6が使用可)
95+
question:
96+
- このセクションに関連する、想定される質問例。
97+
# question: 自体を省略すると、GitHub ActionがGeminiを呼び出して質問例を生成しpushします。
98+
# 質問例が不要な場合は question: [] にしてください。
10099
```
101100
* コード例はそれが配置されているセクションの内容と関連するようにする。
102101
````md

0 commit comments

Comments
 (0)