Files
jekyll/README.md
T

74 lines
1.3 KiB
Markdown
Raw Normal View History

2025-11-29 11:07:00 -05:00
# Jekyll Docker Container with GitHub Pages Support
2023-09-01 14:24:51 -04:00
2025-11-29 11:07:00 -05:00
Docker container for Jekyll static site generator with full GitHub Pages support.
2023-09-01 14:24:51 -04:00
2025-11-29 11:07:00 -05:00
## Features
- Based on Ruby 3.3 Alpine
- Jekyll with latest stable version
- Full GitHub Pages gem support
- Bundler for dependency management
- WEBrick for local serving
- Multi-architecture support (amd64, arm64)
## Usage
### Run Jekyll Server
```bash
2023-09-01 14:24:51 -04:00
docker run -d \
2025-11-29 11:07:00 -05:00
-p 4000:4000 \
-v $(pwd):/srv/jekyll \
casjaysdevdocker/jekyll
2023-09-01 14:24:51 -04:00
```
2025-11-29 11:07:00 -05:00
### Create New Site
```bash
docker run --rm \
-v $(pwd):/srv/jekyll \
casjaysdevdocker/jekyll \
jekyll new my-site
2023-09-01 14:24:51 -04:00
```
2025-11-29 11:07:00 -05:00
### Build Site
```bash
docker run --rm \
-v $(pwd):/srv/jekyll \
casjaysdevdocker/jekyll \
jekyll build
2023-09-01 14:24:51 -04:00
```
2025-11-29 11:07:00 -05:00
### Serve with Live Reload
```bash
docker run -d \
-p 4000:4000 \
-v $(pwd):/srv/jekyll \
casjaysdevdocker/jekyll \
jekyll serve --host 0.0.0.0 --livereload
2023-09-01 14:24:51 -04:00
```
2025-11-29 11:07:00 -05:00
## Environment Variables
- `LANG_VERSION` - Jekyll version (default: latest)
- `SERVICE_PORT` - Port to expose (default: 4000)
## Volumes
- `/srv/jekyll` - Jekyll site directory
- `/usr/local/share/template-files` - Template files
## Ports
- `4000` - Jekyll development server
## GitHub Pages
This container includes the `github-pages` gem which ensures compatibility with GitHub Pages deployment.
## License
MIT - CasjaysDev