Skip to content

Commit 6106b16

Browse files
committed
Update README for more detaield instructions
1 parent 5fb29f0 commit 6106b16

File tree

1 file changed

+24
-3
lines changed

1 file changed

+24
-3
lines changed

README.md

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,10 @@
2222
- :warning: ドメインの適用には DNS 設定が必要です。ココまで設定できたら @yasulab までご連絡ください! :email: :dash:
2323
![Screenshot: GitHub Pages Settings](https://github.com/coderdojo-japan/teaser-template.coderdojo.jp/blob/main/img/pages-settings.png?raw=true)
2424
1. DNS 設定が完了したら、ティザーサイトが公開できているはずです!
25-
- 公開例: [https://teaser-template.coderdojo.jp/](https://teaser-template.coderdojo.jp/)
25+
- 公開例 (1/2): [https://dojocon2024-teaser.coderdojo.jp/](https://dojocon2024-teaser.coderdojo.jp/)
26+
- 公開例 (2/2): [https://teaser-template.coderdojo.jp/](https://teaser-template.coderdojo.jp/)
27+
[![Screenshot of Teaser Site](https://github.com/coderdojo-japan/teaser-template.coderdojo.jp/blob/main/img/screenshot.gif?raw=true)](https://teaser-template.coderdojo.jp/)
28+
2629

2730
<div id='setup'></div>
2831

@@ -32,7 +35,7 @@
3235

3336
### 共通
3437

35-
下記の手順でサーバーが無事立ち上がったら [`index.html`](https://github.com/coderdojo-japan/teaser-template.coderdojo.jp/blob/main/index.html) を修正し、[http://localhost:8080/](http://localhost:8080/) にアクセスして修正内容を確認します
38+
下記の手順でティザーサイトをローカル環境で確認できます。無事に立ち上げられると、ブラウザで [http://localhost:8080/](http://localhost:8080/) にアクセスした際、上記のようなティザーサイトが表示されます
3639

3740
### Ruby で動かす方法
3841

@@ -72,7 +75,6 @@ $ npx http-server
7275

7376
<br>
7477

75-
7678
### PHP で動かす方法
7779

7880
```shell
@@ -83,11 +85,30 @@ $ php --version
8385
$ php -S localhost:8080
8486
```
8587

88+
89+
<div id='customize'></div>
90+
8691
<br>
8792

93+
## :memo: 動かせたら、開催情報などを入力する
94+
95+
前項の手順で [http://localhost:8080/](http://localhost:8080/) からティザーサイトを表示できたら、以下のファイルにある各項目を修正して完成です。
96+
97+
- `index.html`: 開催場所、開催日、テーマ、OGP 画像のパスなど (必須)
98+
- `site.webmanifest`: [スマホでホーム画面に追加](https://www.google.com/search?q=スマホ+ホーム画面+追加)した際に表示されるサイト名 (任意)
99+
- `sitemap.xml`: ドメイン名 (必須)
100+
101+
入力例: [:octocat: coderdojo-japan/dojocon2025-teaser.coderdojo.jp - fill date / location #1](https://github.com/coderdojo-japan/dojocon2025-teaser.coderdojo.jp/pull/1/files)
102+
103+
104+
105+
<div id='references'></div>
106+
107+
<br>
88108

89109
## :octocat: 関連リポジトリ
90110

111+
- [GitHub - ティザーサイト用テンプレート](https://github.com/coderdojo-japan/teaser-template.coderdojo.jp)
91112
- [GitHub - DojoCon Japan リポジトリ一覧](https://github.com/search?q=org%3Acoderdojo-japan%20dojocon&type=repositories)
92113
- [GitHub - CoderDojo Japan organization](https://github.com/coderdojo-japan) (approved by [GitHub for Nonprofit](https://news.coderdojo.jp/2019/08/29/github-for-nonprofit/))
93114

0 commit comments

Comments
 (0)