|
14 | 14 |
|
15 | 15 | ## frontmatter |
16 | 16 |
|
17 | | -| キー | 必須 | 型 | 説明 | |
18 | | -| ----------------- | ---- | ------------ | ----------------------------------------------------------------------------------------------------- | |
19 | | -| `app.name` | ✅ | string | プロジェクト名 | |
20 | | -| `app.description` | ✅ | string | プロジェクトの短い説明。 | |
21 | | -| `app.url` | | string->url | アプリにアクセスできる URL。 | |
22 | | -| `app.platform` | ✅ | string[] | ソフトウェアの配布プラットフォーム。`web`, `mobile`, `desktop`, `cli`。 | |
23 | | -| `app.domain` | ✅ | string[] | ソフトウェアの種別 (クソ雑ドキュメント)。 `app`, `game`, `tool`, `site`, `learn` (教材), `lib` など。 | |
24 | | -| `order` | | number? | 表示順。指定されなかった場合は `date` 降順でソートされます。 | |
25 | | -| `date` | ✅ | date | 記事の初回執筆日。ソートのみで利用しています。 | |
26 | | -| `kind` | ✅ | string | アプリケーションの開発体系。`long-term`, `festival`, `hackathon` の 3 つ。 | |
27 | | -| `status` | ✅ | string | プロジェクトの現状。詳細は `src/schema.ts` を参照。 | |
28 | | -| `members` | | string[]? | プロジェクトのメンバー。まだメンバーページを作ってなくても問題ないです。 | |
29 | | -| `tags` | | string[]? | 使用されている技術。タグごとのフィルタリング機能等は提供していません。 | |
30 | | -| `thumbnail.src` | ✅ | string->path | イメージファイルへの markdown からの相対パス。 | |
31 | | -| `thumbnail.fit` | | string? | イメージのクロップ方法。 default = "cover"。 | |
32 | | -| `thumbnail.bg` | | string? | イメージの背景色。ロード中と `crop` = "contain" のときの背景に使われています。 | |
33 | | -| `social.github` | | string->url? | プロジェクトの GitHub 上での URL。 | |
34 | | -| `social.website` | | string->url? | プロジェクトのウェブサイトの URL。(`app.url` と別で広報用などの Website がある場合) | |
35 | | -| `social.youtube` | | string->url? | プロジェクトの YouTube 上での URL。 | |
36 | | -| `social.twitter` | | string->url? | プロジェクトのツイッター (現 X) の URL。 | |
| 17 | +| キー | 必須 | 型 | 説明 | |
| 18 | +| ----------------- | ---- | ------------- | ----------------------------------------------------------------------------------------------------- | |
| 19 | +| `app.name` | ✅ | string | プロジェクト名 | |
| 20 | +| `app.description` | ✅ | string | プロジェクトの短い説明。 | |
| 21 | +| `app.url` | | string->url | アプリにアクセスできる URL。 | |
| 22 | +| `app.platform` | ✅ | string[] | ソフトウェアの配布プラットフォーム。`web`, `mobile`, `desktop`, `cli`。 | |
| 23 | +| `app.domain` | ✅ | string[] | ソフトウェアの種別 (クソ雑ドキュメント)。 `app`, `game`, `tool`, `site`, `learn` (教材), `lib` など。 | |
| 24 | +| `order` | | number? | 表示順。指定されなかった場合は `date` 降順でソートされます。 | |
| 25 | +| `date` | ✅ | date | 記事の初回執筆日。ソートのみで利用しています。 | |
| 26 | +| `kind` | ✅ | string | アプリケーションの開発体系。`long-term`, `festival`, `hackathon` の 3 つ。 | |
| 27 | +| `status` | ✅ | string | プロジェクトの現状。詳細は `src/schema.ts` を参照。 | |
| 28 | +| `members` | | string[]? | プロジェクトのメンバー。まだメンバーページを作ってなくても問題ないです。 | |
| 29 | +| `tags` | | string[]? | 使用されている技術。タグごとのフィルタリング機能等は提供していません。 | |
| 30 | +| `thumbnail.src` | ✅ | string->path | イメージファイルへの markdown からの相対パス。 | |
| 31 | +| `thumbnail.fit` | | string? | イメージのクロップ方法。 default = "cover"。 | |
| 32 | +| `thumbnail.bg` | | string? | イメージの背景色。ロード中と `crop` = "contain" のときの背景に使われています。 | |
| 33 | +| `favicon` | | string->path? | 強制的に使わせる Favicon。指定しない場合は、アプリの URL から自動で引っ張ってきます。 | |
| 34 | +| `social.github` | | string->url? | プロジェクトの GitHub 上での URL。 | |
| 35 | +| `social.website` | | string->url? | プロジェクトのウェブサイトの URL。(`app.url` と別で広報用などの Website がある場合) | |
| 36 | +| `social.youtube` | | string->url? | プロジェクトの YouTube 上での URL。 | |
| 37 | +| `social.twitter` | | string->url? | プロジェクトのツイッター (現 X) の URL。 | |
37 | 38 |
|
38 | 39 | ## body について |
39 | 40 |
|
|
0 commit comments