|
| 1 | +# Development Container Configuration |
| 2 | + |
| 3 | +This directory contains the configuration for the GitHub Codespaces development container. |
| 4 | + |
| 5 | +## What's Included |
| 6 | + |
| 7 | +This development container provides a complete environment for working with the AI Readiness Primer Quarto website: |
| 8 | + |
| 9 | +- **Base Image**: R development environment (rocker-org/devcontainer/r-ver:4) |
| 10 | +- **Quarto CLI**: Latest version installed via dev container features |
| 11 | +- **VS Code Extensions**: |
| 12 | + - `quarto.quarto` - Official Quarto extension for VS Code |
| 13 | + - `ms-vscode.live-server` - Live server for quick previews |
| 14 | +- **Port Forwarding**: Automatic forwarding of port 4848 (Quarto preview server) |
| 15 | +- **Post-Create Check**: Runs `quarto check` to verify installation |
| 16 | + |
| 17 | +## Using the Dev Container |
| 18 | + |
| 19 | +### With GitHub Codespaces |
| 20 | + |
| 21 | +1. Navigate to the repository on GitHub |
| 22 | +2. Click the "Code" button |
| 23 | +3. Select the "Codespaces" tab |
| 24 | +4. Click "Create codespace on main" |
| 25 | + |
| 26 | +The container will automatically set up, and you'll be ready to work within a few minutes. |
| 27 | + |
| 28 | +### With VS Code Locally |
| 29 | + |
| 30 | +If you have Docker installed and the "Dev Containers" extension for VS Code: |
| 31 | + |
| 32 | +1. Open the repository folder in VS Code |
| 33 | +2. Press `F1` and select "Dev Containers: Reopen in Container" |
| 34 | +3. Wait for the container to build and start |
| 35 | + |
| 36 | +## Working with Quarto |
| 37 | + |
| 38 | +Once your dev container is running, you can use standard Quarto commands: |
| 39 | + |
| 40 | +```bash |
| 41 | +# Preview the site (accessible on forwarded port 4848) |
| 42 | +quarto preview |
| 43 | + |
| 44 | +# Render the site |
| 45 | +quarto render |
| 46 | + |
| 47 | +# Check Quarto installation |
| 48 | +quarto check |
| 49 | +``` |
| 50 | + |
| 51 | +The preview server will be automatically accessible through the forwarded port. |
0 commit comments