Skip to content

Commit 57ce1c2

Browse files
committed
update docs
1 parent c67a419 commit 57ce1c2

File tree

2 files changed

+20
-19
lines changed

2 files changed

+20
-19
lines changed

docs/contents/article.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,27 +19,28 @@
1919

2020
- 著者。
2121

22-
- categories: string[]
22+
- categories?: string[]
2323
- 何なんだろうね。
2424

2525
### image 系
2626

27-
- image: path
27+
- thumbnail.src: path
2828

2929
- タイトル画像。記事一覧とトップで使うよ。
3030
- 縦横比 3:5 に crop されるよ。
3131

32-
- fit?: "cover" | "contain" | fill" | "none" = "cover"
32+
- thumbnail.fit?: "cover" | "contain" | fill" | "none" = "cover"
3333

3434
- `object-fit`
3535
- Astro のビルド段階で Sharp に渡されるよ。
3636
- <https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit>
3737

38-
- position?: "center" | "left" | "right" | "top" | "bottom"
38+
- thumbnail.position?: "center" | "left" | "right" | "top" | "bottom"
3939

4040
- `object-position`
4141
- Astro のビルド段階で Sharp に渡されるよ。
4242

43-
- bg_color?: string
43+
- thumbnail.bg?: string
4444
- ロード中や画像の漏れたところに見せる背景色。
4545
- 設定しないと DaisyUI の `skeleton` を使うよ。
46+
- `fit``contain` の場合は、必須のプロパティだよ。

docs/contents/projects.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -14,20 +14,20 @@
1414

1515
## frontmatter
1616

17-
| キー | 必須 | 説明 |
18-
| ------------- | ---- | ------------------------------------------------------------------------------ |
19-
| `title` || プロジェクト名 |
20-
| `order` | | 表示順。指定されなかった場合は `date` 降順でソートされます。 |
21-
| `date` || 記事の初回執筆日。ソートのみで利用しています。 |
22-
| `image` || イメージ画像に関するデータ。 |
23-
| `image.src` || イメージファイルへの markdown からの相対パス。 |
24-
| `image.fit` | | イメージのクロップ方法。 default = "cover"。 |
25-
| `image.bg` | | イメージの背景色。ロード中と `crop` = "contain" のときの背景に使われています。 |
26-
| `description` || 短い説明。 |
27-
| `tags` | | 使用されている技術など。現状タグごとのフィルタリング機能等は提供していません。 |
28-
| `github` | | プロジェクトの GitHub 上での URL。 |
29-
| `youtube` | | プロジェクトの YouTube 上での URL。 |
30-
| `website` | | プロジェクトのウェブサイトの URL。 |
17+
| キー | 必須 | 説明 |
18+
| --------------- | ---- | ------------------------------------------------------------------------------ |
19+
| `title` || プロジェクト名 |
20+
| `order` | | 表示順。指定されなかった場合は `date` 降順でソートされます。 |
21+
| `date` || 記事の初回執筆日。ソートのみで利用しています。 |
22+
| `thumbnail` || イメージ画像に関するデータ。 |
23+
| `thumbnail.src` || イメージファイルへの markdown からの相対パス。 |
24+
| `thumbnail.fit` | | イメージのクロップ方法。 default = "cover"。 |
25+
| `thumbnail.bg` | | イメージの背景色。ロード中と `crop` = "contain" のときの背景に使われています。 |
26+
| `description` || 短い説明。 |
27+
| `tags` | | 使用されている技術など。現状タグごとのフィルタリング機能等は提供していません。 |
28+
| `github` | | プロジェクトの GitHub 上での URL。 |
29+
| `youtube` | | プロジェクトの YouTube 上での URL。 |
30+
| `website` | | プロジェクトのウェブサイトの URL。 |
3131

3232
## body について
3333

0 commit comments

Comments
 (0)