Skip to content

Commit d23c054

Browse files
committed
add doc
1 parent 3f75bd7 commit d23c054

File tree

2 files changed

+64
-0
lines changed

2 files changed

+64
-0
lines changed

docs/en/DEPLOY_OPTION.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1503,6 +1503,38 @@ const envs: Record<string, Partial<StackInput>> = {
15031503
}
15041504
```
15051505

1506+
## Branding Customization
1507+
1508+
You can customize the logo and title displayed on the landing page by creating a branding configuration file.
1509+
1510+
### Configuration
1511+
1512+
1. Create `packages/cdk/branding.json` with your custom settings:
1513+
1514+
```json
1515+
{
1516+
"logoPath": "your-logo.svg",
1517+
"title": "Your Custom Title"
1518+
}
1519+
```
1520+
1521+
2. Place your custom SVG logo file in `packages/web/src/assets/`:
1522+
1523+
```
1524+
packages/web/src/assets/your-logo.svg
1525+
```
1526+
1527+
### Parameters
1528+
1529+
- `logoPath` (optional): Filename of the SVG logo in `packages/web/src/assets/`
1530+
- `title` (optional): Custom title text to display
1531+
1532+
### Notes
1533+
1534+
- If `branding.json` doesn't exist, default AWS logo and title are used
1535+
- Only SVG format is supported for custom logos
1536+
- The logo will be displayed at 80x80 pixels (size-20 class)
1537+
15061538
## Security-Related Settings
15071539

15081540
### Disable Self-Signup

docs/ja/DEPLOY_OPTION.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1510,6 +1510,38 @@ const envs: Record<string, Partial<StackInput>> = {
15101510
}
15111511
```
15121512

1513+
## ブランディングカスタマイズ
1514+
1515+
ランディングページに表示されるロゴとタイトルをカスタマイズできます。
1516+
1517+
### 設定方法
1518+
1519+
1. `packages/cdk/branding.json` にカスタム設定を作成:
1520+
1521+
```json
1522+
{
1523+
"logoPath": "your-logo.svg",
1524+
"title": "カスタムタイトル"
1525+
}
1526+
```
1527+
1528+
2. カスタムSVGロゴファイルを `packages/web/src/assets/` に配置:
1529+
1530+
```
1531+
packages/web/src/assets/your-logo.svg
1532+
```
1533+
1534+
### パラメータ
1535+
1536+
- `logoPath` (オプション): `packages/web/src/assets/` 内のSVGロゴファイル名
1537+
- `title` (オプション): 表示するカスタムタイトルテキスト
1538+
1539+
### 注意事項
1540+
1541+
- `branding.json` が存在しない場合、デフォルトのAWSロゴとタイトルが使用されます
1542+
- カスタムロゴはSVG形式のみサポートされています
1543+
- ロゴは80x80ピクセル(size-20クラス)で表示されます
1544+
15131545
## セキュリティ関連設定
15141546

15151547
### セルフサインアップを無効化する

0 commit comments

Comments
 (0)