Skip to content

Set up development environment (Ruby 3.2 / Jekyll) #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
lukepan-99 wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Set up development environment (Ruby 3.2 / Jekyll) #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# github-slideshow

A Jekyll static site (GitHub Learning Lab "Introduction to GitHub" course template) that renders Markdown posts in `_posts/` into a [reveal.js](https://github.com/hakimel/reveal.js/) HTML slideshow. There is no backend, database, or API — a single Jekyll process runs the whole product.

## Cursor Cloud specific instructions

- Runtime: Ruby 3.2 + Bundler. Gems install to a user-local path (`bundle config --global path` is set), so `bundle install` does not need `sudo`.
- `Gemfile.lock` was regenerated for Ruby 3.2 (the original lock pinned `nokogiri 1.11.3` / `jekyll 3.9.0`, which only support Ruby < 3.1). It now resolves to `github-pages 232` / `jekyll 3.10.0` (includes `webrick`, required on Ruby 3.x). If `bundle install` ever fails on a stale lock, run `bundle update`.
- Dev server: `bundle exec jekyll serve --host 0.0.0.0 --port 4000` (or `script/server`). Serves the slideshow at `http://localhost:4000/`. Use `--host 0.0.0.0` so it is reachable from outside the VM.
- The harmless `DidYouMean::SPELL_CHECKERS.merge!` deprecation warning prints on every Jekyll/Bundler invocation; ignore it.
- Lint / link check (optional): `script/cibuild` is outdated — it calls `htmlproofer ... --empty-alt-ignore`, a flag removed in the installed html-proofer 5.x and the bare `htmlproofer` is not run via `bundle exec`. Run instead: `bundle exec htmlproofer _site/index.html --disable-external --ignore-empty-alt` (add `--disable-external` to skip network link checks).
- `script/setup`'s rbenv/Brewfile branches are no-ops here (no `.ruby-version`/`Brewfile`); it effectively just runs `bundle install`. `.gitmodules` is empty, so the submodule step is a no-op. `reveal.js` assets are already vendored under `node_modules/` (no `npm install` needed).
Loading