Skip to content

Commit 5cdcb73

Browse files
authored
Merge pull request #2181 from josephaw1022/startup-time-and-note-in-readme
Clarify Jekyll Startup Behavior in README
2 parents 20c9ad7 + 0189cce commit 5cdcb73

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,22 +9,30 @@ These instructions will get you a copy of the Quarkus.io website up and running
99
#### Using Docker
1010

1111
1. Install [Docker Desktop](https://docs.docker.com/install/).
12-
2. Fork the [project repository](https://github.com/quarkusio/quarkusio.github.io), then clone your fork.
12+
2. Fork the [project repository](https://github.com/quarkusio/quarkusio.github.io), then clone your fork:
1313

1414
git clone [email protected]:YOUR_USER_NAME/quarkusio.github.io.git
1515

1616
3. Change into the project directory:
1717

1818
cd quarkusio.github.io
19-
4. Run Docker Composer
19+
20+
4. Run Docker Compose:
2021

2122
docker compose up
2223

23-
If any error occurs mentioning the name conflict, try
24-
24+
> **Note:** The startup process may take several minutes, depending on your system. During this time, you might see logs with warnings or configuration messages (e.g., AutoPages and asciidoctor warnings). This is normal behavior as Jekyll builds the site. Once the server is running, you will see output like this:
25+
26+
```
27+
jekyll-1 | Server address: http://0.0.0.0:4000/
28+
jekyll-1 | Server running... press ctrl-c to stop.
29+
```
30+
31+
If any error occurs mentioning a name conflict, try:
32+
2533
docker compose up --force-recreate
2634
27-
5. Now browse to http://localhost:4000
35+
5. Now browse to [http://localhost:4000](http://localhost:4000).
2836
#### Using a local Ruby environment
2937
[Jekyll static site generator docs](https://jekyllrb.com/docs/).
3038

0 commit comments

Comments
 (0)