Skip to content

Commit c429ba6

Browse files
toshimaruclaude
andcommitted
docs: Add Docker usage instructions to README
Add section explaining how to run the project with Docker Compose, including examples for different Ruby versions and development server. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 4cad591 commit c429ba6

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,26 @@ There are some enhancements in addition to SEO.
2424
- [ ] Comment System
2525
- [ ] etc. (see. https://github.com/railsdoc/railsdoc.github.io/issues)
2626

27-
## Feature Request
27+
## Docker Usage
28+
29+
You can run this project using Docker Compose:
30+
31+
```bash
32+
# Run the application
33+
docker compose run --rm app bundle exec rake
34+
35+
# Run with a specific Ruby version
36+
RUBY_VERSION=3.3 docker compose run --rm app bundle exec rake
37+
38+
# Run Jekyll server for development
39+
docker compose run --rm --service-ports app bundle exec jekyll serve --host 0.0.0.0
40+
```
41+
42+
The Docker setup uses the official Ruby image and includes:
43+
- Ruby with YJIT enabled for better performance
44+
- Automatic bundle installation
45+
- Volume mounting for live development
46+
47+
## Feature Request
2848

2949
Please create an [issue](https://github.com/railsdoc/railsdoc.github.io/issues).

0 commit comments

Comments
 (0)